Struct lychee_lib::Input
source · [−]pub struct Input {
pub source: InputSource,
pub file_type_hint: Option<FileType>,
pub excluded_paths: Option<Vec<PathBuf>>,
}
Expand description
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
sourceimpl Input
impl Input
sourcepub fn new(
value: &str,
file_type_hint: Option<FileType>,
glob_ignore_case: bool,
excluded_paths: Option<Vec<PathBuf>>
) -> Result<Self>
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.
sourcepub async fn get_contents(
self,
skip_missing: bool
) -> impl Stream<Item = Result<InputContent>>
pub async 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)
sourcepub async fn path_content<P: Into<PathBuf> + AsRef<Path> + Clone>(
path: P
) -> Result<InputContent>
pub async fn path_content<P: Into<PathBuf> + AsRef<Path> + Clone>(
path: P
) -> Result<InputContent>
Trait Implementations
impl Eq for Input
impl StructuralEq for Input
impl StructuralPartialEq for Input
Auto Trait Implementations
impl RefUnwindSafe for Input
impl Send for Input
impl Sync for Input
impl Unpin for Input
impl UnwindSafe for Input
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more