Struct lychee_lib::Input

pub struct Input {
    pub source: InputSource,
    pub file_type_hint: Option<FileType>,
    pub excluded_paths: Option<Vec<PathBuf>>,
}

Lychee Input with optional file hint for parsing

Fields

source: InputSource

Origin of input

file_type_hint: Option<FileType>

Hint to indicate which extractor to use

excluded_paths: Option<Vec<PathBuf>>

Excluded paths that will be skipped when reading content

Implementations

impl Input

pub fn new( value: &str, file_type_hint: Option<FileType>, glob_ignore_case: bool, excluded_paths: Option<Vec<PathBuf>> ) -> Result<Self>

Construct a new Input source. In case the input is a glob pattern, glob_ignore_case decides whether matching files against the glob is case-insensitive or not

Errors

Returns an error if the input does not exist (i.e. invalid path) and the input cannot be parsed as a URL.

pub fn get_contents( self, skip_missing: bool ) -> impl Stream<Item = Result<InputContent>>

Retrieve the contents from the input

Errors

Returns an error if the contents can not be retrieved because of an underlying I/O error (e.g. an error while making a network request or retrieving the contents from the file system)

pub fn get_sources(self) -> impl Stream<Item = Result<String>>

Retrieve all sources from this input. The output depends on the type of input:

• Remote URLs are returned as is, in their full form
• Filepath Glob Patterns are expanded and each matched entry is returned
• Absolute or relative filepaths are returned as is
• All other input types are not returned

Errors

Returns an error if the globbing fails with the expanded pattern.

pub async fn path_content<P: Into<PathBuf> + AsRef<Path> + Clone>( path: P ) -> Result<InputContent>

Get the input content of a given path

Errors

Will return Err if file contents can’t be read

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl Hash for Input

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 Input

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Input

impl StructuralPartialEq for Input