Struct Tail 

#[repr(C)]
pub struct Tail<Q, A> {
    pub direction: Direction,
    pub next_state: State<Q>,
    pub write_symbol: A,
}

The Tail of a rule defines the reaction of the actor under specific conditions. Specifically, it defines the next state, the symbol to write, and the direction to move

Fields

direction: Direction

defines the direction to move after writing the symbol

next_state: State<Q>

write_symbol: A

Implementations

impl<Q, A> Tail<Q, A>

where Q: RawState,

pub const fn new(direction: Direction, next_state: Q, write_symbol: A) -> Self

initializes a new Tail with the given direction, state, and symbol

pub const fn stay(state: Q, symbol: A) -> Self

initializes a new Tail at rest using the given state and symbol

pub const fn left(state: Q, symbol: A) -> Self

initializes a new Tail moving to the left using the given state and symbol

pub const fn right(state: Q, symbol: A) -> Self

initializes a new Tail moving to the right using the given state and symbol

pub fn from_head(head: Head<Q, A>) -> Self

returns a new instance of the Tail using the given direction and head

pub fn from_head_with_direction(head: Head<Q, A>, direction: Direction) -> Self

pub const fn as_tuple(&self) -> (Direction, &State<Q>, &A)

returns the direction, state, and symbol as a 3-tuple

pub fn into_tuple(self) -> (Direction, State<Q>, A)

consumes the tail and returns the direction, state, and symbol as a 3-tuple

pub const fn direction(&self) -> Direction

returns a copy of the direction the head should shift after writing the symbol and updating the state.

pub const fn state(&self) -> &State<Q>

returns the next state with an immutable reference to the inner value

pub const fn state_mut(&mut self) -> &mut State<Q>

returns the next state with a mutable reference to the inner value

pub const fn symbol(&self) -> &A

returns the symbol the head is instructed to write

pub const fn symbol_mut(&mut self) -> &mut A

returns a mutable reference to the symbol of the tail

pub const fn set_direction(&mut self, direction: Direction)

update the direction of the tail

pub fn set_state(&mut self, state: Q)

update the configured state for the tail

pub fn set_symbol(&mut self, symbol: A)

update the defined symbol for the tail

pub fn with_direction(self, direction: Direction) -> Self

consumes the current instance to create another with the given Direction

pub fn with_state(self, state: Q) -> Self

consumes the current instance to create another with the given state

pub fn with_symbol(self, symbol: A) -> Self

Configures the tail with a new symbol

pub const fn get_head(&self) -> Head<&Q, &A>

returns an instance of the Head containing references to the next state and symbol.

pub fn get_head_mut(&mut self) -> Head<&mut Q, &mut A>

returns a new Head initialized with mutable references to the state and symbol

pub fn into_head(self) -> Head<Q, A>

consumes the current instance of the tail to convert it into a Head containing the next state and symbol to write.

pub fn into_head_tuple(self) -> (Direction, Head<Q, A>)

convert the tail into a 2-tuple consisting of a Direction and a Head

pub const fn view(&self) -> Tail<&Q, &A>

returns an instance of the head where each element within the created instance is a mutable reference

pub const fn view_mut(&mut self) -> Tail<&mut Q, &mut A>

returns a new Tail containing mutabl references to the state and symbol

impl<'a, Q, S> Tail<&'a Q, &'a S>

where Q: RawState,

pub fn cloned(&self) -> Tail<Q, S>

where Q: Clone, S: Clone,

returns a new Tail with cloned elements

pub const fn copied(&self) -> Tail<Q, S>

where Q: Copy, S: Copy,

returns a new Tail with copied elements

impl<'a, Q, S> Tail<&'a mut Q, &'a mut S>

where Q: RawState,

pub fn cloned(&self) -> Tail<Q, S>

where Q: Clone, S: Clone,

returns a new Tail with cloned elements

pub const fn copied(&self) -> Tail<Q, S>

where Q: Copy, S: Copy,

returns a new Tail with copied elements

Trait Implementations

impl<Q, A, R, B> Add<Head<Q, A>> for Tail<R, B>

where Q: RawState, R: RawState,

type Output = Rule<Q, A, R, B>

The resulting type after applying the + operator.

fn add(self, rhs: Head<Q, A>) -> Self::Output

Performs the + operation.

impl<Q, A, R, B> Add<Tail<R, B>> for Head<Q, A>

where Q: RawState, R: RawState,

type Output = Rule<Q, A, R, B>

The resulting type after applying the + operator.

fn add(self, rhs: Tail<R, B>) -> Self::Output

Performs the + operation.

impl<Q, S> AsMut<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn as_mut(&mut self) -> &mut Tail<Q, S>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Q, S> AsRef<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn as_ref(&self) -> &Tail<Q, S>

Converts this type into a shared reference of the (usually inferred) input type.

impl<Q, A> Borrow<Direction> for Tail<Q, A>

where Q: RawState,

fn borrow(&self) -> &Direction

Immutably borrows from an owned value.

impl<Q, A> Borrow<State<Q>> for Tail<Q, A>

where Q: RawState,

fn borrow(&self) -> &State<Q>

Immutably borrows from an owned value.

impl<Q, S> Borrow<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn borrow(&self) -> &Tail<Q, S>

Immutably borrows from an owned value.

impl<Q, A> BorrowMut<State<Q>> for Tail<Q, A>

where Q: RawState,

fn borrow_mut(&mut self) -> &mut State<Q>

Mutably borrows from an owned value.

impl<Q, S> BorrowMut<Tail<Q, S>> for Rule<Q, S>

where Q: RawState,

fn borrow_mut(&mut self) -> &mut Tail<Q, S>

Mutably borrows from an owned value.

impl<Q: Clone, A: Clone> Clone for Tail<Q, A>

fn clone(&self) -> Tail<Q, A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q, A> Debug for Tail<Q, A>

where Q: Debug, A: Debug,

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

Formats the value using the given formatter.

impl<Q: Default, A: Default> Default for Tail<Q, A>

fn default() -> Tail<Q, A>

Returns the “default value” for a type.

impl<Q, S> Display for Tail<Q, S>

where Q: Display, S: Display,

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

Formats the value using the given formatter.

impl<Q, A> From<(Direction, Head<Q, A>)> for Tail<Q, A>

fn from((direction, head): (Direction, Head<Q, A>)) -> Self

Converts to this type from the input type.

impl<Q, A> From<(Direction, Q, A)> for Tail<Q, A>

fn from((direction, next_state, write_symbol): (Direction, Q, A)) -> Self

Converts to this type from the input type.

impl<Q, A> From<(Direction, State<Q>, A)> for Tail<Q, A>

fn from((direction, next_state, write_symbol): (Direction, State<Q>, A)) -> Self

Converts to this type from the input type.

impl<Q, A> From<Tail<Q, A>> for (Direction, Head<Q, A>)

fn from(tail: Tail<Q, A>) -> Self

Converts to this type from the input type.

impl<Q, A> From<Tail<Q, A>> for (Direction, State<Q>, A)

fn from(tail: Tail<Q, A>) -> Self

Converts to this type from the input type.

impl<Q: Hash, A: Hash> Hash for Tail<Q, A>

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<Q: Ord, A: Ord> Ord for Tail<Q, A>

fn cmp(&self, other: &Tail<Q, A>) -> 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<Q, A> PartialEq<(Direction, Head<Q, A>)> for Tail<Q, A>

where Q: PartialEq, A: PartialEq,

fn eq(&self, (other_direction, other_head): &(Direction, Head<Q, A>)) -> 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<Q, A> PartialEq<(Direction, State<Q>, A)> for Tail<Q, A>

where Q: PartialEq, A: PartialEq,

fn eq( &self, (other_direction, other_state, other_symbol): &(Direction, State<Q>, A), ) -> 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<Q, A> PartialEq<(State<Q>, A)> for Tail<Q, A>

where Q: PartialEq, A: PartialEq,

fn eq(&self, (other_state, other_symbol): &(State<Q>, A)) -> 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<Q, A> PartialEq<Tail<Q, A>> for (Direction, State<Q>, A)

where Q: PartialEq, A: PartialEq,

fn eq(&self, other: &Tail<Q, A>) -> 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<Q, A> PartialEq<Tail<Q, A>> for (State<Q>, A)

where Q: PartialEq, A: PartialEq,

fn eq(&self, other: &Tail<Q, A>) -> 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<Q, S> PartialEq<Tail<Q, S>> for Rule<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, other: &Tail<Q, S>) -> 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<Q: PartialEq, A: PartialEq> PartialEq for Tail<Q, A>

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

fn partial_cmp(&self, other: &Tail<Q, A>) -> 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<Q, A> RawTail for Tail<Q, A>

where Q: RawState,

fn direction(&self) -> Direction

returns the direction of the tail.

fn next_state(&self) -> &State<Q>

returns an immutable reference to the next state.

fn write_symbol(&self) -> &A

returns an immutable reference to the symbol to write.

type State = Q

type Symbol = A

impl<Q, A> RawTailMut for Tail<Q, A>

where Q: RawState,

fn direction_mut(&mut self) -> &mut Direction

returns a mutable reference to the direction of the tail.

fn next_state_mut(&mut self) -> &mut State<Q>

returns a mutable reference to the next state.

fn write_symbol_mut(&mut self) -> &mut A

returns a mutable reference to the symbol to write.

impl<Q, A> TailRepr for Tail<Q, A>

where Q: RawState,

fn new(direction: Direction, next_state: Q, write_symbol: A) -> Self

creates a new tail from the given direction, next state, and symbol to write

fn right(next_state: Self::State, write_symbol: Self::Symbol) -> Self

creates a new tail that moves right after writing the symbol and transitioning to the next state

fn left(next_state: Self::State, write_symbol: Self::Symbol) -> Self

creates a new tail that moves left after writing the symbol and transitioning to the next state

fn stay(next_state: Self::State, write_symbol: Self::Symbol) -> Self

impl<Q: Copy, A: Copy> Copy for Tail<Q, A>

impl<Q: Eq, A: Eq> Eq for Tail<Q, A>

impl<Q, A> StructuralPartialEq for Tail<Q, A>