Struct LinkLine

pub struct LinkLine { /* private fields */ }

A column in a linking row.

Implementations

impl LinkLine

pub const HORIZ_PARENT: LinkLine

This cell contains a horizontal line that connects to a parent.

pub const HORIZ_ANCESTOR: LinkLine

This cell contains a horizontal line that connects to an ancestor.

pub const VERT_PARENT: LinkLine

The descendent of this cell is connected to the parent.

pub const VERT_ANCESTOR: LinkLine

The descendent of this cell is connected to an ancestor.

pub const LEFT_FORK_PARENT: LinkLine

The parent of this cell is linked in this link row and the child is to the left.

pub const LEFT_FORK_ANCESTOR: LinkLine

The ancestor of this cell is linked in this link row and the child is to the left.

pub const RIGHT_FORK_PARENT: LinkLine

The parent of this cell is linked in this link row and the child is to the right.

pub const RIGHT_FORK_ANCESTOR: LinkLine

The ancestor of this cell is linked in this link row and the child is to the right.

pub const LEFT_MERGE_PARENT: LinkLine

The child of this cell is linked to parents on the left.

pub const LEFT_MERGE_ANCESTOR: LinkLine

The child of this cell is linked to ancestors on the left.

pub const RIGHT_MERGE_PARENT: LinkLine

The child of this cell is linked to parents on the right.

pub const RIGHT_MERGE_ANCESTOR: LinkLine

The child of this cell is linked to ancestors on the right.

pub const CHILD: LinkLine

The target node of this link line is the child of this column. This disambiguates between the node that is connected in this link line, and other nodes that are also connected vertically.

pub const HORIZONTAL: LinkLine

pub const VERTICAL: LinkLine

pub const LEFT_FORK: LinkLine

pub const RIGHT_FORK: LinkLine

pub const LEFT_MERGE: LinkLine

pub const RIGHT_MERGE: LinkLine

pub const ANY_MERGE: LinkLine

pub const ANY_FORK: LinkLine

pub const ANY_FORK_OR_MERGE: LinkLine

pub const fn empty() -> LinkLine

Returns an empty set of flags.

pub const fn all() -> LinkLine

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u16) -> Option<LinkLine>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u16) -> LinkLine

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u16) -> LinkLine

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: LinkLine) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: LinkLine) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: LinkLine)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: LinkLine)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: LinkLine)

Toggles the specified flags in-place.

pub fn set(&mut self, other: LinkLine, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: LinkLine) -> LinkLine

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: LinkLine) -> LinkLine

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: LinkLine) -> LinkLine

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: LinkLine) -> LinkLine

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> LinkLine

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for LinkLine

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

Formats the value using the given formatter.

impl BitAnd for LinkLine

fn bitand(self, other: LinkLine) -> LinkLine

Returns the intersection between the two sets of flags.

type Output = LinkLine

The resulting type after applying the & operator.

impl BitAndAssign for LinkLine

fn bitand_assign(&mut self, other: LinkLine)

Disables all flags disabled in the set.

impl BitOr for LinkLine

fn bitor(self, other: LinkLine) -> LinkLine

Returns the union of the two sets of flags.

type Output = LinkLine

The resulting type after applying the | operator.

impl BitOrAssign for LinkLine

fn bitor_assign(&mut self, other: LinkLine)

Adds the set of flags.

impl BitXor for LinkLine

fn bitxor(self, other: LinkLine) -> LinkLine

Returns the left flags, but with all the right flags toggled.

type Output = LinkLine

The resulting type after applying the ^ operator.

impl BitXorAssign for LinkLine

fn bitxor_assign(&mut self, other: LinkLine)

Toggles the set of flags.

impl Clone for LinkLine

fn clone(&self) -> LinkLine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkLine

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

Formats the value using the given formatter.

impl Default for LinkLine

fn default() -> LinkLine

Returns the “default value” for a type.

impl Extend<LinkLine> for LinkLine

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = LinkLine>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<LinkLine> for LinkLine

fn from_iter<T>(iterator: T) -> LinkLine

where T: IntoIterator<Item = LinkLine>,

Creates a value from an iterator.

impl Hash for LinkLine

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

where __H: Hasher,

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 LowerHex for LinkLine

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

Formats the value using the given formatter.

impl Not for LinkLine

fn not(self) -> LinkLine

Returns the complement of this set of flags.

type Output = LinkLine

The resulting type after applying the ! operator.

impl Octal for LinkLine

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

Formats the value using the given formatter.

impl Ord for LinkLine

fn cmp(&self, other: &LinkLine) -> 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 PartialEq for LinkLine

fn eq(&self, other: &LinkLine) -> 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 PartialOrd for LinkLine

fn partial_cmp(&self, other: &LinkLine) -> 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 Sub for LinkLine

fn sub(self, other: LinkLine) -> LinkLine

Returns the set difference of the two sets of flags.

type Output = LinkLine

The resulting type after applying the - operator.

impl SubAssign for LinkLine

fn sub_assign(&mut self, other: LinkLine)

Disables all flags enabled in the set.

impl UpperHex for LinkLine

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

Formats the value using the given formatter.

impl Copy for LinkLine

impl Eq for LinkLine

impl StructuralPartialEq for LinkLine