Struct ParseFile

Source
pub struct ParseFile<'a> {
    pub input: &'a str,
}
Expand description

A structure representing a file to be parsed.

Fields§

§input: &'a str

Implementations§

Source§

impl<'a> ParseFile<'a>

Source

pub const fn new(input: &'a str) -> Self

Constructs a new ParseFile with the provided input.

Source

pub fn parse(&self) -> ParserResult<'_, Vec<Snippet>>

Parses the input file content and extracts snippets.

§Errors

This function may return an error if it fails to parse the input file. Other errors encountered during parsing will be logged.

Source

pub fn inject( &self, snippets: &HashMap<String, &DbDataSnippet>, ) -> ParserResult<'_, InjectSummary>

Injects snippets in the input file content based on the provided Snippet map.

§Errors

This function may return an error if it fails to parse the input file. Other errors encountered during parsing will be logged.

Source

pub fn get_attributes(tag: &str) -> ParserResult<'_, BTreeMap<String, String>>

Extracts the attributes from the given HTML tag.

For Example:

  • The given tag is <snipgrep id="quick_start"> the result will be {“id”: “quick_start”}
§Errors

This function returns an error in the following cases:

  • The tag is not of type snipgrep.
  • The tag cannot be parsed.

Auto Trait Implementations§

§

impl<'a> Freeze for ParseFile<'a>

§

impl<'a> RefUnwindSafe for ParseFile<'a>

§

impl<'a> Send for ParseFile<'a>

§

impl<'a> Sync for ParseFile<'a>

§

impl<'a> Unpin for ParseFile<'a>

§

impl<'a> UnwindSafe for ParseFile<'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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more