Skip to main content

Pending

Struct Pending 

Source
pub struct Pending { /* private fields */ }
Expand description

A classification waiting for file content (see classify()).

Content is needed when the name gives no text/binary tag (unknown names and EXTENSIONS_NEED_BINARY_CHECK entries) and, for executable files with an unknown name, to read the shebang.

Implementations§

Source§

impl Pending

Source

pub const fn tags(&self) -> TagSet

The tags known so far (type, mode and name tags).

Source

pub const fn needs_shebang(&self) -> bool

Whether the shebang must be parsed (an executable file whose name gave no tags).

Source

pub const fn needs_encoding(&self) -> bool

Whether text/binary must be decided from the content (always true when needs_shebang is).

Source

pub fn finish<R: Read>(self, reader: R) -> Result<TagSet>

Finish from the file’s content read from its start.

Reads TEXT_PROBE_LEN bytes (fewer at end of input); only a shebang line longer than that reads further, bounded by MAX_SHEBANG_BYTES.

§Errors

Propagates read errors.

Source

pub fn finish_bytes(self, content: &[u8]) -> TagSet

Finish from in-memory content (the whole file or at least its first TEXT_PROBE_LEN bytes plus the shebang line).

use file_identify::{Classification, Meta, classify};

let Classification::NeedsContent(pending) = classify(Meta::regular(true), "bin/tool") else {
    unreachable!()
};
let tags = pending.finish_bytes(b"#!/usr/bin/env python3\nprint('hi')\n");
assert_eq!(tags.to_string(), "executable, file, python, python3, text");

Trait Implementations§

Source§

impl Clone for Pending

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Pending

Source§

impl Debug for Pending

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Pending

Source§

impl PartialEq for Pending

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Pending

Auto Trait Implementations§

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.