Struct Rule 

pub struct Rule<Q = String, A = char>
where
    Q: RawState,
{
    pub head: Head<Q, A>,
    pub tail: Tail<Q, A>,
}

The Rule implementation is a concrete representation of a single instruction, or rule, within a given Turing machine program. It encapsulates the necessary components to define the behavior of the Turing machine when it encounters a specific state and symbol.

Note: The inner fields are flattened for serialization purposes when using serde; this means that the fields of the Head and Tail structs will be serialized as if they were direct fields of the Rule struct itself.

Fields

head: Head<Q, A>

tail: Tail<Q, A>

Implementations

impl<Q, A> Rule<Q, A>

where Q: RawState,

pub const fn new(head: Head<Q, A>, tail: Tail<Q, A>) -> Self

returns a new instance of the Rule from the given head and tail

pub const fn create() -> RuleBuilder<Q, A>

returns a new instance of a RuleBuilder for constructing a new Rule

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

initialize a new instance of the Rule from its consituent parts

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

returns an immutable reference to the Head

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

returns a mutable reference to the Head

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

returns an immutable reference to the Tail of the [Instruction]

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

returns a mutable reference to the Tail of the [Instruction]

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

returns an instance of the Head whose elements are immutable references

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

returns an instance of the Tail whose elements are immutable references

pub const fn direction(&self) -> Direction

returns the direction of the shift

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

returns the current State of the system

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

returns a mutable reference to the current State of the system

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

returns the symbol of the Head

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

returns a mutable reference to the symbol of the Head

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

returns the next State of the system

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

returns a mutable reference to the next State of the system

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

returns the symbol which will be written by the Head

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

returns a mutable reference to the next symbol

pub fn set_direction(&mut self, direction: Direction) -> &mut Self

updates the current Direction and returns a mutable reference to the Rule

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

update the current symbol and return a mutable reference to the Rule

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

updates the current State and returns a mutable reference to the Rule

pub fn set_next_state(&mut self, state: Q) -> &mut Self

updates the current State and returns a mutable reference to the Rule

pub fn set_next_symbol(&mut self, symbol: A) -> &mut Self

updates the next symbol and returns a mutable reference to the Rule

pub fn set_head(&mut self, state: Q, symbol: A) -> &mut Self

updates the current State and symbol and returns a mutable reference to the Rule

pub fn set_tail(&mut self, state: Q, symbol: A) -> &mut Self

updates the current State and symbol and returns a mutable reference to the Rule

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

returns the next Head of the system

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

consumes the current object and returns the next Head of the system

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

returns the value which for which the current object will be replaced with

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

consumes the current object and returns a 2-tuple consisting of the Head and Tail

pub fn cloned(&self) -> Rule<Q, A>

where Q: Clone, A: Clone,

returns a new instance of the Rule with cloned elements

pub fn copied(&self) -> Rule<Q, A>

where Q: Clone, A: Clone,

returns a new instance of the Rule with copied elements

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> 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<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> 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, 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> 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, 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, 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, A: Clone> Clone for Rule<Q, A>

where Q: RawState + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q, A: Debug> Debug for Rule<Q, A>

where Q: RawState + Debug,

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

Formats the value using the given formatter.

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

where Q: RawState + Default,

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

Returns the “default value” for a type.

impl<'de, Q, A> Deserialize<'de> for Rule<Q, A>

where Q: RawState + Deserialize<'de>, A: 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> Directive<Q, S> for Rule<Q, S>

where Q: RawState,

fn direction(&self) -> Direction

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

fn next_symbol(&self) -> &S

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

where Q: RawState,

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

Converts to this type from the input type.

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

where Q: RawState,

fn from(rule: Rule<Q, S>) -> Self

Converts to this type from the input type.

impl<Q, S, T> From<Rule<Q, S>> for LearnedRule<T, Q, S>

where Q: RawState, T: Default,

fn from(rule: Rule<Q, S>) -> Self

Converts to this type from the input type.

impl<Q, S> From<RuleBuilder<Q, S>> for Rule<Q, S>

where Q: RawState,

fn from(builder: RuleBuilder<Q, S>) -> Self

Converts to this type from the input type.

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

where Q: RawState + Hash,

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

where Q: RawState + Ord,

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

where Q: RawState + PartialEq, S: PartialEq,

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

where Q: RawState + PartialEq,

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

where Q: RawState + PartialOrd,

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

where Q: RawState,

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

returns an immutable reference to the current state

fn current_symbol(&self) -> &S

impl<Q, A> Serialize for Rule<Q, A>

where Q: RawState + Serialize, A: 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, A: Copy> Copy for Rule<Q, A>

where Q: RawState + Copy,

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

where Q: RawState + Eq,

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

where Q: RawState,