Skip to main content

ConfigData

Struct ConfigData 

Source
pub struct ConfigData {
Show 26 fields pub internal_url: String, pub external_url: String, pub internal_url_enabled: bool, pub external_url_enabled: bool, pub watch_paths: Vec<WatchPathEntry>, pub run_on_startup: bool, pub pause_on_metered_network: bool, pub pause_on_battery_power: bool, pub background_sync_enabled: bool, pub notifications_enabled: bool, pub startup_catchup_mode: StartupCatchupMode, pub upload_concurrency: u8, pub quiet_hours_start: Option<u8>, pub quiet_hours_end: Option<u8>, pub library_view_enabled: bool, pub download_target_path: Option<String>, pub library_preview_full_resolution: bool, pub library_grid_quality: String, pub cache_disk_cap_mb: u32, pub raw_decode_cache_enabled: bool, pub raw_full_decode: bool, pub show_unnamed_faces: bool, pub show_hidden_faces: bool, pub upload_xmp_sidecars: bool, pub grid_border_width: f32, pub grid_border_color: String,
}
Expand description

Configuration schema driving application behavior and connection settings.

Fields§

§internal_url: String

Active local Immich server connection address.

§external_url: String

Active remote or external connection address.

§internal_url_enabled: bool

True if internal URL connection is enabled.

§external_url_enabled: bool

True if external URL connection is enabled.

§watch_paths: Vec<WatchPathEntry>

List of watched local directory entries.

§run_on_startup: bool

True if application should launch automatically at user login.

§pause_on_metered_network: bool

Pause transfers when metered connections are detected.

§pause_on_battery_power: bool

Pause transfers when system runs on battery.

§background_sync_enabled: bool

Whether automatic background monitoring/upload discovery is enabled.

§notifications_enabled: bool

Whether desktop notifications (sync summary, connectivity lost, etc.) are shown.

§startup_catchup_mode: StartupCatchupMode

Default catch-up scanning strategy when background scan starts.

§upload_concurrency: u8

Number of parallel upload workers (1–10). Defaults to 3.

§quiet_hours_start: Option<u8>

Quiet-hours window start (local clock hour, 0-23). None means disabled.

§quiet_hours_end: Option<u8>

Quiet-hours window end (local clock hour, 0-23, exclusive).

§library_view_enabled: bool

Whether the built-in library viewer is the primary window.

§download_target_path: Option<String>

Target folder for asset downloads from the library viewer.

§library_preview_full_resolution: bool

When true, lightbox loads original full-resolution image instead of preview.

§library_grid_quality: String

Grid thumbnail quality: “auto”, “thumbnail”, “preview”. Defaults to auto.

§cache_disk_cap_mb: u32

Total on-disk cache cap in megabytes across all subcaches (thumbnails, raw_decode, exif, video, preview, open-in). Pruning runs once at startup. Defaults to 2000 MB.

§raw_decode_cache_enabled: bool

When true, decoded RAW textures are cached to disk for faster re-opens. Disable to save storage; each cached file is a full-resolution PNG.

§raw_full_decode: bool

When true, RAW files are fully demosaiced from sensor data (slow but highest quality). When false the embedded camera JPEG preview is extracted instead (near-instant).

§show_unnamed_faces: bool

Show people with no assigned name in the Explore view.

§show_hidden_faces: bool

Include hidden people in the Explore view.

§upload_xmp_sidecars: bool

Attach XMP sidecar files alongside media during upload. Per-folder rules can override this global default.

§grid_border_width: f32

Border width between grid tiles in pixels (0.0 = edge-to-edge, max 10.0).

§grid_border_color: String

Border color as a CSS hex string (e.g. “#ffffff”). Defaults to white.

Trait Implementations§

Source§

impl Clone for ConfigData

Source§

fn clone(&self) -> ConfigData

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfigData

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ConfigData

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ConfigData

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ConfigData

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T, Ctx> BundleDefault<Ctx> for T
where T: Default,

§

fn default_with_context(_: Ctx) -> T

Creates a default value with the given context.
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more