Struct handlegraph::handle::Handle

#[repr(transparent)]pub struct Handle(pub u64);

A Handle is a node ID with an orientation, packed as a single u64

Implementations

impl Handle

pub fn as_integer(self) -> u64

pub const fn from_integer(i: u64) -> Self

pub fn unpack_number(self) -> u64

pub fn unpack_bit(self) -> bool

pub fn new<T: Into<NodeId>>(id: T, orient: Orientation) -> Handle

pub fn pack<T: Into<NodeId>>(id: T, is_reverse: bool) -> Handle

pub fn id(self) -> NodeId

pub fn is_reverse(&self) -> bool

pub fn flip(self) -> Self

pub fn forward(self) -> Self

Trait Implementations

impl Clone for Handle

pub fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Handle

impl Debug for Handle

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

Formats the value using the given formatter.

impl Eq for Handle

impl From<Handle> for NodeId

Unpacks the NodeId from a Handle

pub fn from(h: Handle) -> NodeId

Performs the conversion.

impl From<NodeId> for Handle

Returns the forward-oriented Handle for a NodeId

pub fn from(id: NodeId) -> Handle

Performs the conversion.

impl Hash for Handle

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Handle

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PackedElement for Handle

A Handle can be packed for use in a packed collection -- it is already a packed u64.

pub fn unpack(v: u64) -> Self

pub fn pack(self) -> u64

impl PartialEq<Handle> for Handle

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

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

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

This method tests for !=.

impl PartialOrd<Handle> for Handle

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Handle

impl StructuralPartialEq for Handle