Struct Sink 

pub struct Sink { /* private fields */ }

A push-only sink for recorded introspections, delayed errors, warnings, and traced values.

All tracked methods of this type are of the form (&mut self, ..) -> (), so in principle they do not need validation (though that optimization is not yet implemented in comemo).

Implementations

impl Sink

pub const MAX_VALUES: usize = 10

The maximum number of traced values.

pub fn new() -> Self

Create a new empty sink.

pub fn introspections(&self) -> &[Introspection]

Get the introspections.

pub fn delayed(&mut self) -> EcoVec<SourceDiagnostic>

Get the stored delayed errors.

pub fn warnings(self) -> EcoVec<SourceDiagnostic>

Get the stored warnings.

pub fn values(self) -> EcoVec<(Value, Option<Styles>)>

Get the values for the traced span.

pub fn extend_from_sink(&mut self, other: Sink)

Extend from another sink.

impl Sink

pub fn introspection(&mut self, introspection: Introspection)

Trace an introspection.

pub fn delayed_error(&mut self, error: SourceDiagnostic)

Add a delayed error.

pub fn delayed_errors(&mut self, errors: EcoVec<SourceDiagnostic>)

Add multiple delayed errors.

pub fn warn(&mut self, warning: SourceDiagnostic)

Add a warning.

pub fn value(&mut self, value: Value, styles: Option<Styles>)

Trace a value and optionally styles for the traced span.

Trait Implementations

impl Clone for Sink

fn clone(&self) -> Sink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Sink

fn default() -> Sink

Returns the “default value” for a type.

impl Track for Sink

type Call = __ComemoCall

An enumeration of possible tracked calls that can be performed on this tracked type.

fn call(&self, call: &Self::Call) -> u128

Performs a call on the value and returns the hash of its results.

fn call_mut(&mut self, call: &Self::Call)

Performs a mutable call on the value.

fn track(&self) -> Tracked<'_, Self>

Start tracking all accesses to a value.

fn track_mut(&mut self) -> TrackedMut<'_, Self>

Start tracking all accesses and mutations to a value.

fn track_with<'a>( &'a self, sink: &'a dyn Sink<Call = Self::Call>, ) -> Tracked<'a, Self>

Start tracking all accesses into a sink.

fn track_mut_with<'a>( &'a mut self, sink: &'a dyn Sink<Call = Self::Call>, ) -> TrackedMut<'a, Self>

Start tracking all accesses and mutations into a sink.