Enum CacheDir

pub enum CacheDir {
    IsEnabled(bool),
    CustomPath(PathBuf),
}

A cache directory config field.

This cache directory configuration field is optional. It defaults to being enabled with the default config path, but also allows a custom path to be set.

Variants

IsEnabled(bool)

Whether the cache directory is enabled with the default path (true), or disabled (false).

CustomPath(PathBuf)

Enable the cache directory and use a custom path.

Implementations

impl CacheDir

pub fn default_path() -> Self

Returns a CacheDir enabled with the default path.

pub fn disabled() -> Self

Returns a disabled CacheDir.

pub fn custom_path(path: impl AsRef<Path>) -> Self

Returns a custom CacheDir enabled with path.

pub fn is_enabled(&self) -> bool

Returns true if this CacheDir is enabled with the default or a custom path.

pub fn peer_cache_file_path(&self, network: &Network) -> Option<PathBuf>

Returns the peer cache file path for network, if enabled.

pub fn cache_dir(&self) -> Option<PathBuf>

Returns the zebra-network base cache directory, if enabled.

Trait Implementations

impl Clone for CacheDir

fn clone(&self) -> CacheDir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheDir

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

Formats the value using the given formatter.

impl Default for CacheDir

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CacheDir

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PathBuf> for CacheDir

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl From<bool> for CacheDir

fn from(value: bool) -> Self

Converts to this type from the input type.

impl PartialEq for CacheDir

fn eq(&self, other: &CacheDir) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CacheDir

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CacheDir

impl StructuralPartialEq for CacheDir