Skip to main content

FileInfo

Struct FileInfo 

Source
pub struct FileInfo<'a> {
    pub filename: &'a str,
    pub file_kind: FileKind,
    pub is_executable: bool,
    pub content: Option<&'a [u8]>,
}
Expand description

Pre-loaded file information for I/O-free identification.

Use this when you have file data from a source other than the host filesystem (e.g., a mocked/virtual filesystem in tests).

§Examples

use file_identify::{tags_from_info, FileInfo, FileKind};

let info = FileInfo {
    filename: "script.py",
    file_kind: FileKind::Regular,
    is_executable: false,
    content: Some(b"print('hello')"),
};
let tags = tags_from_info(&info);
assert!(tags.contains("python"));
assert!(tags.contains("text"));

Fields§

§filename: &'a str

The filename (just the name component, not a full path).

§file_kind: FileKind

The kind of filesystem entry.

§is_executable: bool

Whether the file has executable permissions.

§content: Option<&'a [u8]>

Optional file content for shebang and encoding analysis. Pass None to skip content-based analysis entirely.

Trait Implementations§

Source§

impl<'a> Clone for FileInfo<'a>

Source§

fn clone(&self) -> FileInfo<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for FileInfo<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for FileInfo<'a>

§

impl<'a> RefUnwindSafe for FileInfo<'a>

§

impl<'a> Send for FileInfo<'a>

§

impl<'a> Sync for FileInfo<'a>

§

impl<'a> Unpin for FileInfo<'a>

§

impl<'a> UnsafeUnpin for FileInfo<'a>

§

impl<'a> UnwindSafe for FileInfo<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.