Struct Context

pub struct Context<'o, 'c, T = ()> {
    pub options: &'o Options<'c>,
    pub plugins: &'o Plugins<'o>,
    pub anchorizer: Anchorizer,
    pub user: T,
    /* private fields */
}

Expand description

Context struct given to formatter functions as taken by html::format_document_with_formatter. Output can be appended to through this struct’s Write interface.

Fields§

§options: &'o Options<'c>

Options in use in this render.

§plugins: &'o Plugins<'o>

Plugins in use in this render.

§anchorizer: Anchorizer

Anchorizer instance used in this render.

§user: T

Any user data used by the Context.

Implementations§

impl<'o, 'c, T> Context<'o, 'c, T>

pub fn cr(&mut self) -> Result<()>

If the last byte written to ts Write interface was not a U+000A LINE FEED, writes one. Otherwise, does nothing.

(In other words, ensures the output is at a new line.)

pub fn escape(&mut self, buffer: &[u8]) -> Result<()>

Convenience wrapper for html::escape.

pub fn escape_href(&mut self, buffer: &[u8]) -> Result<()>

Convenience wrapper for html::escape_href.

Trait Implementations§

impl<'o, 'c, T> Debug for Context<'o, 'c, T>

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

Formats the value using the given formatter. Read more

impl<'o, 'c, T> Write for Context<'o, 'c, T>

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more

1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation. Read more

1.0.0 · Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer. Read more

1.0.0 · Source§

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more

1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

impl<'o, 'c, T = ()> !Freeze for Context<'o, 'c, T>

impl<'o, 'c, T = ()> !RefUnwindSafe for Context<'o, 'c, T>

impl<'o, 'c, T = ()> !Send for Context<'o, 'c, T>

impl<'o, 'c, T = ()> !Sync for Context<'o, 'c, T>

impl<'o, 'c, T> Unpin for Context<'o, 'c, T>
where T: Unpin,

impl<'o, 'c, T = ()> !UnwindSafe for Context<'o, 'c, T>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.