Enum Location 

pub enum Location {
    Simple(String),
    Detailed {
        scheme: Scheme,
        uri: String,
    },
}

Abstraction for file and folder locations that can be local (e.g., file:///path/to/project) or remote (e.g., https://gitlab.com/project)

Variants

Simple(String)

Just the URI string (assumes remote location)

Detailed

Location defined by URI and scheme - intended for use with remote or local locations

Fields

scheme: Scheme

URI Scheme

See RFC 8089 for more information

uri: String

Full URI value

Implementations

impl Location

pub fn hash(&self) -> String

Get associated location hash

Useful for standardizing file path handling across local and remote contexts

Example

use acorn::Location;

let location = Location::Simple("https://code.ornl.gov/research-enablement/buckets/nssd".to_string());
assert_eq!(location.hash(), "code_ornl_gov_research-enablement_buckets_nssd");

pub fn scheme(&self) -> Scheme

Get associated location value scheme (e.g., https, file, etc.)

Example

use acorn::{Location, Scheme};

let location = Location::Simple("https://code.ornl.gov/research-enablement/buckets/nssd".to_string());
assert_eq!(location.scheme(), Scheme::HTTPS);
let location = Location::Simple("file://localhost/buckets/nssd".to_string());
assert_eq!(location.scheme(), Scheme::File);

pub async fn exists(self) -> bool

Check if a location exists (i.e., is reachable and accessible)

pub fn uri(&self) -> Option<URI<'static>>

Extract and return URI from a location value

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Location

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Location

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

Formats the value using the given formatter.

impl From<Location> for Endpoint

fn from(value: Location) -> Self

Converts to this type from the input type.

impl Serialize for Location

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

where __S: Serializer,

Serialize this value into the given Serde serializer.