Enum IndexLocation

pub enum IndexLocation {
    Local(PathBuf),
    Remote(String),
}

Defines an enum that either defines a local path to fetch packages / datasets from, or a remote location to fetch packages / datasets from.

Variants

Local(PathBuf)

It’s a local location

Remote(String)

It’s a remote address

Implementations

impl IndexLocation

pub fn serialize(&self) -> IndexLocationSerializer<'_>

Returns a formatter for the IndexLocation that writes it in an unambigious, serialized way.

pub fn is_local(&self) -> bool

Returns whether this index location is a local path.

pub fn local(&self) -> &PathBuf

Returns the path in this IndexLocation as if it is a Local location.

Panics

This function will panic if self is not a Self::Local.

pub fn local_mut(&mut self) -> &mut PathBuf

Returns a mutable path in this IndexLocation as if it is a Local location.

Panics

This function will panic if self is not a Self::Local.

pub fn into_local(self) -> PathBuf

Consumes this IndexLocation into a local path as if it is a Local location.

Panics

This function will panic if self is not a Self::Local.

pub fn is_remote(&self) -> bool

Returns whether this index location is a remote address.

pub fn remote(&self) -> &String

Returns the address in this IndexLocation as if it is a Remote location.

Panics

This function will panic if self is not a Self::Remote.

pub fn remote_mut(&mut self) -> &mut String

Returns a mutable address in this IndexLocation as if it is a Remote location.

Panics

This function will panic if self is not a Self::Remote.

pub fn into_remote(self) -> String

Consumes this IndexLocation into a remote address as if it is a Remote location.

Panics

This function will panic if self is not a Self::Remote.

Trait Implementations

impl AsRef<IndexLocation> for IndexLocation

fn as_ref(&self) -> &Self

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

impl Clone for IndexLocation

fn clone(&self) -> IndexLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexLocation

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

Formats the value using the given formatter.

impl Display for IndexLocation

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

Formats the value using the given formatter.

impl EnumDebug for IndexLocation

fn type_name() -> &'static str

Returns the static name of the type used for EnumDebug-printing.

fn variant_names() -> &'static [&'static str]

Returns all variants in the trait as a list of names.

fn variant_name(&self) -> &'static str

Returns the static name of the variant.

fn variant(&self) -> EnumDebugFormatter<'_, Self>

Returns a formatter for this enum that writes its variant name.

fn variants() -> Copied<Iter<'static, &'static str>>

Returns an iterator over all variants in this enum.

impl From<&IndexLocation> for IndexLocation

fn from(value: &IndexLocation) -> Self

Converts to this type from the input type.

impl From<&mut IndexLocation> for IndexLocation

fn from(value: &mut IndexLocation) -> Self

Converts to this type from the input type.

impl<T: AsRef<str>> From<T> for IndexLocation

fn from(value: T) -> Self

Converts to this type from the input type.

impl FromStr for IndexLocation

type Err = IndexLocationParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for IndexLocation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for IndexLocation

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

impl StructuralPartialEq for IndexLocation