Struct Input 

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

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

If this is not provided, the extractor will be guessed from the input (e.g. file extension or URL path)

Implementations

impl Input

pub fn new( input: &str, file_type_hint: Option<FileType>, glob_ignore_case: bool, ) -> 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. the path is invalid)
• the input cannot be parsed as a URL

pub fn from_value(value: &str) -> Result<Self>

Convenience constructor with default settings

Errors

Returns an error if:

• the input does not exist (i.e. the path is invalid)
• the input cannot be parsed as a URL

pub const fn from_input_source(source: InputSource) -> Self

Create an Input from an existing InputSource

The file type will be determined later when processing the input.

pub fn get_contents( self, skip_missing: bool, skip_hidden: bool, skip_gitignored: bool, file_extensions: FileExtensions, resolver: UrlContentResolver, excluded_paths: PathExcludes, ) -> impl Stream<Item = Result<InputContent>>

Retrieve the contents from the input

If the input is a path, only search through files that match the given file extensions.

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, file_extensions: FileExtensions, skip_hidden: bool, skip_gitignored: bool, excluded_paths: &PathExcludes, ) -> 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 glob pattern is invalid or expansion encounters I/O errors
• Directory traversal fails, including:
  • Permission denied when accessing directories or files
  • I/O errors while reading directory contents
  • Filesystem errors (disk errors, network filesystem issues, etc.)
  • Invalid file paths or symbolic link resolution failures
• Errors when reading or evaluating .gitignore or .ignore files
• Errors occur during file extension or path exclusion evaluation

Note: Individual glob match failures are logged to stderr but don’t terminate the stream. However, directory traversal errors will stop processing and return the error immediately.

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

Get the content for a given path.

Errors

Returns an error if the file cannot be read

pub async fn stdin_content( file_type_hint: Option<FileType>, ) -> Result<InputContent>

Create InputContent from stdin.

Errors

Returns an error if stdin cannot be read

pub fn string_content(s: &str, file_type_hint: Option<FileType>) -> InputContent

Create InputContent from a string.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate 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

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 TryFrom<&str> for Input

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Input

impl StructuralPartialEq for Input