Struct ImagePath 

pub struct ImagePath { /* private fields */ }

A wrapper for a path that is a file. It can be either an animated wallpaper or a static wallpaper.

Implementations

impl ImagePath

pub fn new(path: PathBuf) -> Option<Self>

pub fn is_animated(&mut self, settings: &Settings) -> bool

Checks if the given path is an animated wallpaper, if the value has been set before it will return the cached value, else it will check if the path is an animated wallpaper and cache the result.

An animated wallperper can be either a file or a folder. If it is a folder it must be contained in the wallpaper directory. If it is a file it must be contained in a folder that is contained in the wallpaper directory.

Example: wallpaper_dir |— folder1 | |— wallpaper1 |– wallpaper2

folder1 is an animated wallpaper wallpaper1 is an animated wallpaper wallpaper2 is not an animated wallpaper

pub fn get_animated_wallpaper_name(&self) -> String

Gets the name of the folder that contains the given path. If the folder name is not cached it will cache it.

Panics

If the path is not an animated wallpaper it may panic.

pub const fn get_animated_number(&self) -> Option<u32>

pub fn path(&self) -> &Path

pub fn get_sleep_time(&mut self, settings: &Settings) -> Result<u64>

Trait Implementations

impl Display for ImagePath

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

Formats the value using the given formatter.

impl From<String> for ImagePath

fn from(path: String) -> Self

Converts to this type from the input type.