Struct stack_graphs::arena::Handle

#[repr(transparent)]
pub struct Handle<T> { /* private fields */ }

A handle to an instance of type T that was allocated from an Arena.

Safety

Because of the type parameter T, the compiler can ensure that you don’t use a handle for one type to index into an arena of another type. However, if you have multiple arenas for the same type, we do not do anything to ensure that you only use a handle with the corresponding arena.

Implementations

impl<T> Handle<T>

pub fn as_u32(self) -> u32

pub fn as_usize(self) -> usize

impl Handle<Symbol>

pub fn display(self, graph: &StackGraph) -> impl Display + '_

impl Handle<InternedString>

pub fn display(self, graph: &StackGraph) -> impl Display + '_

impl Handle<File>

pub fn display(self, graph: &StackGraph) -> impl Display + '_

impl Handle<Node>

pub fn display(self, graph: &StackGraph) -> impl Display + '_

Trait Implementations

impl<T> Clone for Handle<T>

fn clone(&self) -> Handle<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Handle<T>

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

Formats the value using the given formatter.

impl<T> Hash for Handle<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<Handle<File>> for StackGraph

type Output = File

The returned type after indexing.

fn index(&self, handle: Handle<File>) -> &File

Performs the indexing (container[index]) operation.

impl<H, T> Index<Handle<H>> for SupplementalArena<H, T>

type Output = T

The returned type after indexing.

fn index(&self, handle: Handle<H>) -> &T

Performs the indexing (container[index]) operation.

impl Index<Handle<InternedString>> for StackGraph

type Output = str

The returned type after indexing.

fn index(&self, handle: Handle<InternedString>) -> &str

Performs the indexing (container[index]) operation.

impl Index<Handle<Node>> for StackGraph

type Output = Node

The returned type after indexing.

fn index(&self, handle: Handle<Node>) -> &Node

Performs the indexing (container[index]) operation.

impl Index<Handle<PartialPath>> for Database

type Output = PartialPath

The returned type after indexing.

fn index(&self, handle: Handle<PartialPath>) -> &PartialPath

Performs the indexing (container[index]) operation.

impl Index<Handle<Symbol>> for StackGraph

type Output = str

The returned type after indexing.

fn index(&self, handle: Handle<Symbol>) -> &str

Performs the indexing (container[index]) operation.

impl<H, T> IndexMut<Handle<H>> for SupplementalArena<H, T>where
    T: Default,

fn index_mut(&mut self, handle: Handle<H>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Handle<Node>> for StackGraph

fn index_mut(&mut self, handle: Handle<Node>) -> &mut Node

Performs the mutable indexing (container[index]) operation.

impl Into<Handle<File>> for sg_file_handle

fn into(self) -> Handle<File>

Converts this type into the (usually inferred) input type.

impl Into<Handle<Node>> for sg_node_handle

fn into(self) -> Handle<Node>

Converts this type into the (usually inferred) input type.

impl<T> Niche for Handle<T>

type Output = u32

The type that is used to store values of Self inside of a ControlledOption. This might be Self itself, if your niche is a valid instance of the type, but which violates some runtime constraint. But if you cannot easily create your niche as an instance of Self, you can use some other type, you can use some other type instead.

fn none() -> Self::Output

Returns the niche value for this type that should be used to represent None for a ControlledOption.

fn is_none(value: &Self::Output) -> bool

Returns whether value is the niche value for this type.

fn into_some(value: Self) -> Self::Output

Transforms a non-niche value of this type into its Output type. When Output is Self, this will be the identity function.

fn from_some(value: Self::Output) -> Self

Transforms a non-niche value of this type from its Output type. When Output is Self, this will be the identity function.

impl<T> Ord for Handle<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T> PartialEq<Handle<T>> for Handle<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd<Handle<T>> for Handle<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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Copy for Handle<T>

impl<T> Eq for Handle<T>

impl<T> Send for Handle<T>

impl<T> Sync for Handle<T>