Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 23 fields pub desktop: Desktop, pub directories: Vec<PathBuf>, pub extensions: Vec<String>, pub interval: u64, pub min_dimension: u64, pub max_dimension: u64, pub min_size: u64, pub max_size: u64, pub monitors: Vec<Monitor>, pub monitor_orientation: Orientation, pub once: bool, pub path_feh: PathBuf, pub sort: bool, pub effect: ProceduralEffect, pub effects: EffectsConfig, pub wallpaper: PathBuf, pub dry_run: bool, pub transition_type: String, pub transition_duration: u16, pub transition_fps: u16, pub transition_angle: u16, pub transition_pos: String, pub verbose: bool,
}
Expand description

Configuration variables

Fields§

§desktop: Desktop

Desktops: gnome, xfce, openbox, …

§directories: Vec<PathBuf>

Directories containing image files

§extensions: Vec<String>

Image file extension (identify -list format)

§interval: u64

Interval (in seconds) between each wallpaper displayed

§min_dimension: u64

Minimum dimension

§max_dimension: u64

Maximum dimension

§min_size: u64

Minimum file size

§max_size: u64

Maximum file size

§monitors: Vec<Monitor>

Monitor properties

§monitor_orientation: Orientation

Attach images to monitors in the Horizontal or Vertical orientation

§once: bool

Run a single wallpaper update cycle and exit

§path_feh: PathBuf

feh binary path

§sort: bool

Sort the images found

§effect: ProceduralEffect

Selected procedural overlay effect (none, fractal, star, random)

§effects: EffectsConfig

Configurable parameters and custom presets for mathematical overlays

§wallpaper: PathBuf

Wallpaper file path used by gnome desktop

§dry_run: bool

Run without actually applying wallpapers (Simulation mode)

§transition_type: String

Animation transition type for awww daemon

§transition_duration: u16

Duration of awww transition in seconds

§transition_fps: u16

Framerate of the awww transition animation

§transition_angle: u16

Angle for wipe/wave transitions

§transition_pos: String

Starting position for center/outer transitions

§verbose: bool

Show intermediate runtime messages

Implementations§

Source§

impl Config

Source

pub fn new(args: &Arguments, env: &Environment<'_>) -> WallSwitchResult<Self>

Merges settings from the JSON configuration file with parsed command-line overrides.

§Errors

Returns a WallSwitchResult if config reading or validation fails.

Source

pub fn default_with_env(env: &Environment<'_>) -> Self

Initializes a default configuration aligned with the active environment context.

Source§

impl Config

Source

pub fn in_range(&self, value: u64) -> bool

Check if the value is in the range

Source

pub fn print(&self) -> WallSwitchResult<()>

Print Config

Source

pub fn validate_config(self) -> WallSwitchResult<Self>

Validate configuration

Source

pub fn write_config_file( self, path: &Path, read_default_config: bool, ) -> WallSwitchResult<Self>

Write config file path:: “/home/user_name/.config/wallswitch/wallswitch.json”

To ensure atomic write and protect against sudden crashes or interruptions, the configuration is written to a temporary file in the target directory and then renamed.

Source

pub fn get_number_of_images(&self) -> usize

Get the number of images per cycle

Trait Implementations§

Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Config

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 Config

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
Source§

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

Source§

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

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.

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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.