Enum Source 

pub enum Source {
    Local {
        name: Option<String>,
        path: PathBuf,
        action: Option<SourceAction>,
    },
    Remote {
        name: Option<String>,
        identifier: String,
    },
    Unsupported(String),
}

Operational/transient source — a one-shot parse-and-read type for I/O operations.

This is the complementary counterpart to Location: whereas Location is a descriptive data type meant for configuration and serialization, Source is a lightweight runtime type that drives actual byte reads from disk or HTTP(S).

Prefer to parse user-provided source strings with Source::read / Source::read_bytes, and reserve Location for stored configuration values.

Variants

Local

Local filesystem path.

Fields

name: Option<String>

Optional display name for the source

path: PathBuf

Local filesystem path

action: Option<SourceAction>

Optional action to use when materializing the source

Remote

Remote HTTP(S) URL

Fields

name: Option<String>

Optional display name for the source

identifier: String

Remote identifier, repository ID, or URL

Unsupported(String)

URI scheme that cannot be read as an ACORN source

Implementations

impl Source

pub const fn is_local(&self) -> bool

Returns true if the enum is Source::Local otherwise false

pub const fn is_remote(&self) -> bool

Returns true if the enum is Source::Remote otherwise false

pub const fn is_unsupported(&self) -> bool

Returns true if the enum is Source::Unsupported otherwise false

impl Source

pub async fn read(source: &str, offline: bool) -> ApiResult<String>

Reads source content from a URL or local file path.

When source starts with http:// or https://, the content is downloaded. Otherwise, the source is treated as a local file path and read from disk.

Returns an error if URL access is requested while offline is enabled.

pub async fn read_bytes(source: &str, offline: bool) -> ApiResult<Vec<u8>>

Reads source bytes from a URL, file URI, or local file path.

HTTP(S) sources are rejected when offline is enabled.

pub fn parse(source: &str) -> Self

Parses a user-provided source string into a source location.

Note

Delegates URI scheme detection to [Location::from_str].

pub fn name(&self) -> String

Return the user-facing source name.

pub fn identifier(&self) -> String

Return a stable identifier for deduplication or output paths.

pub fn with_action(self, action: Option<SourceAction>) -> Self

Return a source with a materialization action.

pub fn with_name(self, value: impl Into<String>) -> Self

Return a source with a display name.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Display for Source

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

Formats the value using the given formatter.

impl Eq for Source

impl From<&Repository> for Source

fn from(repository: &Repository) -> Self

Converts to this type from the input type.

impl From<&Source> for Weights

fn from(source: &Source) -> Self

Converts to this type from the input type.

impl From<&str> for Source

fn from(selector: &str) -> Self

Converts to this type from the input type.

impl From<Location> for Source

fn from(location: Location) -> Self

Converts to this type from the input type.

impl PartialEq for Source

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Source