Enum Source

pub enum Source {
    Stdin,
    Path(PathBuf),
    Url(Url),
}

A source for data that needs to be deserialized.

Variants

Stdin

Stdin source.

Path(PathBuf)

Local file or directory source.

Url(Url)

Remote URL source.

Implementations

impl Source

pub fn as_path(&self) -> Option<&Path>

Returns Some if the source is a local path, None otherwise.

pub fn is_dir(&self) -> bool

Returns true if the Source is a local path and the path exists on disk and is pointing at a directory.

pub fn encoding(&self) -> Option<Encoding>

Tries to detect the encoding of the source. Returns None if the encoding cannot be detected.

pub fn glob_files(&self, pattern: &str) -> Result<Vec<Source>>

If source is a local path, this returns sources for all files matching the glob pattern.

Errors

Returns an error if the sink is not of variant Sink::Path, the pattern is invalid or if there is a io::Error while reading the file system.

pub fn to_reader(&self) -> Result<SourceReader>

Returns a SourceReader to read from the source.

Errors

May return an error if the source is Source::Path and the file cannot be opened of if source is Source::Url and there is an error requesting the remote url.

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 From<&Path> for Source

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for Source

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for Source

type Err = Infallible

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 PartialEq for Source

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