Struct Head

#[repr(C)]
pub struct Head<Q, S> {
    pub state: State<Q>,
    pub symbol: S,
}

The Head is formally defined to be a 2-tuple consisting of a state / symbol pair.

Fields

state: State<Q>

symbol: S

Implementations

impl<Q, S> Head<Q, S>

where Q: RawState,

pub const fn new(state: State<Q>, symbol: S) -> Self

pub fn from_state(state: State<Q>) -> Self

where S: Default,

Create a new instance of the Head using the given state and default symbol.

pub fn from_symbol(symbol: S) -> Self

where Q: Default,

Create a new instance of the Head using the given symbol and default state.

pub fn from_tuple((state, symbol): (State<Q>, S)) -> Self

Create a new instance from a 2-tuple: (state, symbol)

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

Updates the current state and returns a new head

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

Updates the current symbol and returns a new head

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

Returns a reference to the current state

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

Returns a mutable reference to the current State

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

Returns a reference to the current symbol

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

Returns a mutable reference to the current symbol

pub fn as_tuple(&self) -> (&State<Q>, &S)

Returns a reference to the current state and symbol returing a 2-tuple

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

Consumes the head and returns the current state and symbol as a 2-tuple

pub fn as_mut_tuple(&mut self) -> (&mut State<Q>, &mut S)

Returns a mutable reference to the current state and symbol as a 2-tuple

pub fn set_state(&mut self, State: State<Q>) -> &mut Self

Updates the current state

pub fn set_symbol(&mut self, symbol: S) -> &mut Self

Updates the current symbol

pub fn replace(&mut self, state: State<Q>, symbol: S) -> Self

Replaces the current state and symbol with the given state and symbol; returns the previous instance of the head.

pub const fn replace_state(&mut self, state: State<Q>) -> State<Q>

replace the current state with the given state, returning the previous state

pub const fn replace_symbol(&mut self, symbol: S) -> S

replace the current symbol with the given symbol, returning the previous symbol

pub const fn swap(&mut self, other: &mut Self)

swap the current state and symbol with those of the given head

pub fn update(&mut self, state: Option<State<Q>>, symbol: Option<S>)

Updates the current State and symbol

pub const fn view(&self) -> Head<&Q, &S>

returns a new head with immutable references to the current state and symbol

pub fn view_mut(&mut self) -> Head<&mut Q, &mut S>

returns a new head with mutable references to the current state and symbol

pub fn read<T>(self, tape: &[T]) -> Option<&S::Output>

where S: SliceIndex<[T]>,

tries reading the given tape using the head as its coordinates.

pub fn to_ref(&self) -> Head<&Q, &S>

👎Deprecated since 0.0.7: use view instead, as it is more idiomatic and clearer.

pub fn to_mut(&mut self) -> Head<&mut Q, &mut S>

👎Deprecated since 0.0.7: use view_mut instead, as it is more idiomatic and clearer.

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

where Q: RawState,

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

where Q: Clone, S: Clone,

returns a new Head with cloned elements

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

where Q: Copy, S: Copy,

returns a new Head with copied elements

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

where Q: RawState,

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

where Q: Clone, S: Clone,

returns a new Head with cloned elements

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

where Q: Copy, S: Copy,

returns a new Head with copied elements

impl<Q> Head<Q, usize>

where Q: RawState,

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

pub fn shift_inplace(&mut self, direction: Direction)

Trait Implementations

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

where Q: RawState,

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

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

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

where Q: RawState,

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

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

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

where Q: RawState,

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

Immutably borrows from an owned value.

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

where Q: RawState,

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

Mutably borrows from an owned value.

impl<Q: Clone, S: Clone> Clone for Head<Q, S>

fn clone(&self) -> Head<Q, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q, S> Debug for Head<Q, S>

where Q: RawState, S: Debug,

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

Formats the value using the given formatter.

impl<Q: Default, S: Default> Default for Head<Q, S>

fn default() -> Head<Q, S>

Returns the “default value” for a type.

impl<'de, Q, S> Deserialize<'de> for Head<Q, S>

where Q: Deserialize<'de>, S: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where Q: RawState, S: Display,

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

Formats the value using the given formatter.

impl<Q, S> From<(Q, S)> for Head<Q, S>

where Q: RawState,

fn from((state, symbol): (Q, S)) -> Self

Converts to this type from the input type.

impl<Q, S> From<(State<Q>, S)> for Head<Q, S>

where Q: RawState,

fn from((state, symbol): (State<Q>, S)) -> Self

Converts to this type from the input type.

impl<Q, S> From<Head<Q, S>> for (State<Q>, S)

where Q: RawState,

fn from(head: Head<Q, S>) -> Self

Converts to this type from the input type.

impl<Q: Hash, S: Hash> Hash for Head<Q, S>

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, S> Index<Head<Q, S>> for RuleMap<Q, S>

where Q: RawState + Eq + Hash, S: Eq + Hash,

type Output = Tail<Q, S>

The returned type after indexing.

fn index(&self, head: Head<Q, S>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<Q, S> Index<Head<Q, S>> for RuleSet<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

type Output = Tail<Q, S>

The returned type after indexing.

fn index(&self, index: Head<Q, S>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<Q: Ord, S: Ord> Ord for Head<Q, S>

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

where State<Q>: PartialEq, Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, (state, symbol): &(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, S> PartialEq<(State<Q>, S)> for Head<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, (state, symbol): &(State<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, S> PartialEq<Head<Q, S>> for (State<Q>, S)

where Q: RawState + PartialEq, S: PartialEq,

fn eq(&self, head: &Head<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, S> PartialEq<Head<Q, S>> for Rule<Q, S>

where Q: RawState + PartialEq, S: PartialEq,

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

where Q: RawState + PartialEq,

fn eq(&self, head: &Head<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, S> PartialEq<Head<Q, S>> for State<Q>

where Q: RawState + PartialEq,

fn eq(&self, head: &Head<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<'a, Q, S> PartialEq<State<&'a Q>> for Head<Q, S>

where Q: RawState + PartialEq,

fn eq(&self, state: &State<&'a Q>) -> 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<State<Q>> for Head<Q, S>

where Q: RawState + PartialEq,

fn eq(&self, state: &State<Q>) -> 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, S: PartialEq> PartialEq for Head<Q, S>

fn eq(&self, other: &Head<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: PartialOrd, S: PartialOrd> PartialOrd for Head<Q, S>

fn partial_cmp(&self, other: &Head<Q, S>) -> 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, S> Scope<Q, S> for Head<Q, S>

where Q: RawState,

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

fn current_symbol(&self) -> &S

impl<Q, S> Serialize for Head<Q, S>

where Q: Serialize, S: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Q: Copy, S: Copy> Copy for Head<Q, S>

impl<Q: Eq, S: Eq> Eq for Head<Q, S>

impl<Q, S> StructuralPartialEq for Head<Q, S>