Struct ImmutableBorrow

pub struct ImmutableBorrow<T: ?Sized> { /* private fields */ }

A guard for a virtual immutable borrow of the global token of type T.

These can be thought of as Refs to those global tokens except that they have no impact on the runtime and only contribute to AuToken’s static analysis of the binary.

As with borrow_mutably and friends, setting T to Nothing causes this guard to have no effect on the statically-analyzed borrow counts.

Developers wishing to integrate their crate with AuToken will likely use this type to represent the static counterpart to a runtime borrow of some cell of type T as described in the Integrating AuToken section of the crate documentation.

End-users consuming crates with integrations with AuToken, meanwhile, will likely only use these guards for loaned borrows as described by the Making Sense of Control Flow Errors section of the crate documentation.

Implementations

impl<T: ?Sized> ImmutableBorrow<T>

pub const fn new() -> Self

Constructs a new ImmutableBorrow guard.

This function has no runtime cost but will cause the AuToken static analyzer to report potential virtual borrowing issues with other guards.

Internally, this function just calls borrow_immutably with the provided type T.

pub fn downgrade(self) -> PotentialImmutableBorrow<T>

Transforms this ImmutableBorrow into a PotentialImmutableBorrow of the same type.

pub fn downgrade_ref(&self) -> &PotentialImmutableBorrow<T>

Transforms a reference to ImmutableBorrow into a reference to a PotentialImmutableBorrow of the same type.

pub fn downgrade_mut(&mut self) -> &mut PotentialImmutableBorrow<T>

Transforms a mutable reference to ImmutableBorrow into a mutable reference to a PotentialImmutableBorrow of the same type.

pub const fn loan(&self) -> ImmutableBorrow<Nothing<'_>>

Creates a loaned ImmutableBorrow of this guard which has no effect on the static analysis borrow counters by itself, making it safe to use in conditional code.

See the Making Sense of Control Flow Errors section of the crate documentation for more details on loans.

pub fn strip_lifetime_analysis(self) -> ImmutableBorrow<Nothing<'static>>

Transforms the type of T into Nothing, effectively making it as if this borrow guard no longer exists.

See the Making Sense of Control Flow Errors section of the crate documentation for more details on the utility of strip_lifetime_analysis.

Trait Implementations

impl<T: ?Sized> Clone for ImmutableBorrow<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for ImmutableBorrow<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Default for ImmutableBorrow<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> Drop for ImmutableBorrow<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized> Ord for ImmutableBorrow<T>

fn cmp(&self, _other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: ?Sized> PartialEq for ImmutableBorrow<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized> PartialOrd for ImmutableBorrow<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized> Eq for ImmutableBorrow<T>