Struct PlatformPath

pub struct PlatformPath<D>(/* private fields */);

A wrapper type that either parses a user-given path or defaults to an OS-specific path.

The FromStr implementation supports shell expansions and common patterns such as ~ for the home directory.

Example

use reth_node_core::dirs::{DataDirPath, PlatformPath};
use std::str::FromStr;

// Resolves to the platform-specific database path
let default: PlatformPath<DataDirPath> = PlatformPath::default();
// Resolves to `$(pwd)/my/path/to/datadir`
let custom: PlatformPath<DataDirPath> = PlatformPath::from_str("my/path/to/datadir").unwrap();

assert_ne!(default.as_ref(), custom.as_ref());

Implementations

impl<D> PlatformPath<D>

pub fn join<P>(&self, path: P) -> PlatformPath<D>

where P: AsRef<Path>,

Returns the path joined with another path

impl<D> PlatformPath<D>

pub fn with_chain( &self, chain: Chain, datadir_args: DatadirArgs, ) -> ChainPath<D>

Converts the path to a ChainPath with the given Chain.

pub fn map_to<T>(&self) -> PlatformPath<T>

Map the inner path to a new type T.

Trait Implementations

impl<D> AsRef<Path> for PlatformPath<D>

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl<D> Clone for PlatformPath<D>

fn clone(&self) -> PlatformPath<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D> Debug for PlatformPath<D>

where D: Debug,

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

Formats the value using the given formatter.

impl<D> Default for PlatformPath<D>

where D: XdgPath,

fn default() -> PlatformPath<D>

Returns the “default value” for a type.

impl<D> Display for PlatformPath<D>

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

Formats the value using the given formatter.

impl<D> From<PlatformPath<D>> for PathBuf

fn from(value: PlatformPath<D>) -> PathBuf

Converts to this type from the input type.

impl<D> FromStr for PlatformPath<D>

type Err = LookupError<VarError>

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<PlatformPath<D>, <PlatformPath<D> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<D> PartialEq for PlatformPath<D>

where D: PartialEq,

fn eq(&self, other: &PlatformPath<D>) -> 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<D> Eq for PlatformPath<D>

where D: Eq,

impl<D> StructuralPartialEq for PlatformPath<D>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes