pub enum Pattern<R = TextRange> {
    MatchValue(PatternMatchValue<R>),
    MatchSingleton(PatternMatchSingleton<R>),
    MatchSequence(PatternMatchSequence<R>),
    MatchMapping(PatternMatchMapping<R>),
    MatchClass(PatternMatchClass<R>),
    MatchStar(PatternMatchStar<R>),
    MatchAs(PatternMatchAs<R>),
    MatchOr(PatternMatchOr<R>),
}
Expand description

See also pattern

Variants§

§

MatchValue(PatternMatchValue<R>)

§

MatchSingleton(PatternMatchSingleton<R>)

§

MatchSequence(PatternMatchSequence<R>)

§

MatchMapping(PatternMatchMapping<R>)

§

MatchClass(PatternMatchClass<R>)

§

MatchStar(PatternMatchStar<R>)

§

MatchAs(PatternMatchAs<R>)

§

MatchOr(PatternMatchOr<R>)

Implementations§

source§

impl<R> Pattern<R>

source

pub const fn is_match_value(&self) -> bool

Returns true if self is of variant MatchValue.

source

pub fn as_match_value(&self) -> Option<&PatternMatchValue<R>>

Returns Some if self is a reference of variant MatchValue, and None otherwise.

source

pub fn as_mut_match_value(&mut self) -> Option<&mut PatternMatchValue<R>>

Returns Some if self is a mutable reference of variant MatchValue, and None otherwise.

source

pub fn expect_match_value(self) -> PatternMatchValue<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchValue.

§Panics

Panics if the value is not MatchValue, with a panic message including the content of self.

source

pub fn match_value(self) -> Option<PatternMatchValue<R>>

Returns Some if self is of variant MatchValue, and None otherwise.

source

pub const fn is_match_singleton(&self) -> bool

Returns true if self is of variant MatchSingleton.

source

pub fn as_match_singleton(&self) -> Option<&PatternMatchSingleton<R>>

Returns Some if self is a reference of variant MatchSingleton, and None otherwise.

source

pub fn as_mut_match_singleton( &mut self ) -> Option<&mut PatternMatchSingleton<R>>

Returns Some if self is a mutable reference of variant MatchSingleton, and None otherwise.

source

pub fn expect_match_singleton(self) -> PatternMatchSingleton<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchSingleton.

§Panics

Panics if the value is not MatchSingleton, with a panic message including the content of self.

source

pub fn match_singleton(self) -> Option<PatternMatchSingleton<R>>

Returns Some if self is of variant MatchSingleton, and None otherwise.

source

pub const fn is_match_sequence(&self) -> bool

Returns true if self is of variant MatchSequence.

source

pub fn as_match_sequence(&self) -> Option<&PatternMatchSequence<R>>

Returns Some if self is a reference of variant MatchSequence, and None otherwise.

source

pub fn as_mut_match_sequence(&mut self) -> Option<&mut PatternMatchSequence<R>>

Returns Some if self is a mutable reference of variant MatchSequence, and None otherwise.

source

pub fn expect_match_sequence(self) -> PatternMatchSequence<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchSequence.

§Panics

Panics if the value is not MatchSequence, with a panic message including the content of self.

source

pub fn match_sequence(self) -> Option<PatternMatchSequence<R>>

Returns Some if self is of variant MatchSequence, and None otherwise.

source

pub const fn is_match_mapping(&self) -> bool

Returns true if self is of variant MatchMapping.

source

pub fn as_match_mapping(&self) -> Option<&PatternMatchMapping<R>>

Returns Some if self is a reference of variant MatchMapping, and None otherwise.

source

pub fn as_mut_match_mapping(&mut self) -> Option<&mut PatternMatchMapping<R>>

Returns Some if self is a mutable reference of variant MatchMapping, and None otherwise.

source

pub fn expect_match_mapping(self) -> PatternMatchMapping<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchMapping.

§Panics

Panics if the value is not MatchMapping, with a panic message including the content of self.

source

pub fn match_mapping(self) -> Option<PatternMatchMapping<R>>

Returns Some if self is of variant MatchMapping, and None otherwise.

source

pub const fn is_match_class(&self) -> bool

Returns true if self is of variant MatchClass.

source

pub fn as_match_class(&self) -> Option<&PatternMatchClass<R>>

Returns Some if self is a reference of variant MatchClass, and None otherwise.

source

pub fn as_mut_match_class(&mut self) -> Option<&mut PatternMatchClass<R>>

Returns Some if self is a mutable reference of variant MatchClass, and None otherwise.

source

pub fn expect_match_class(self) -> PatternMatchClass<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchClass.

§Panics

Panics if the value is not MatchClass, with a panic message including the content of self.

source

pub fn match_class(self) -> Option<PatternMatchClass<R>>

Returns Some if self is of variant MatchClass, and None otherwise.

source

pub const fn is_match_star(&self) -> bool

Returns true if self is of variant MatchStar.

source

pub fn as_match_star(&self) -> Option<&PatternMatchStar<R>>

Returns Some if self is a reference of variant MatchStar, and None otherwise.

source

pub fn as_mut_match_star(&mut self) -> Option<&mut PatternMatchStar<R>>

Returns Some if self is a mutable reference of variant MatchStar, and None otherwise.

source

pub fn expect_match_star(self) -> PatternMatchStar<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchStar.

§Panics

Panics if the value is not MatchStar, with a panic message including the content of self.

source

pub fn match_star(self) -> Option<PatternMatchStar<R>>

Returns Some if self is of variant MatchStar, and None otherwise.

source

pub const fn is_match_as(&self) -> bool

Returns true if self is of variant MatchAs.

source

pub fn as_match_as(&self) -> Option<&PatternMatchAs<R>>

Returns Some if self is a reference of variant MatchAs, and None otherwise.

source

pub fn as_mut_match_as(&mut self) -> Option<&mut PatternMatchAs<R>>

Returns Some if self is a mutable reference of variant MatchAs, and None otherwise.

source

pub fn expect_match_as(self) -> PatternMatchAs<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchAs.

§Panics

Panics if the value is not MatchAs, with a panic message including the content of self.

source

pub fn match_as(self) -> Option<PatternMatchAs<R>>

Returns Some if self is of variant MatchAs, and None otherwise.

source

pub const fn is_match_or(&self) -> bool

Returns true if self is of variant MatchOr.

source

pub fn as_match_or(&self) -> Option<&PatternMatchOr<R>>

Returns Some if self is a reference of variant MatchOr, and None otherwise.

source

pub fn as_mut_match_or(&mut self) -> Option<&mut PatternMatchOr<R>>

Returns Some if self is a mutable reference of variant MatchOr, and None otherwise.

source

pub fn expect_match_or(self) -> PatternMatchOr<R>
where Self: Debug,

Unwraps the value, yielding the content of MatchOr.

§Panics

Panics if the value is not MatchOr, with a panic message including the content of self.

source

pub fn match_or(self) -> Option<PatternMatchOr<R>>

Returns Some if self is of variant MatchOr, and None otherwise.

Trait Implementations§

source§

impl<R: Clone> Clone for Pattern<R>

source§

fn clone(&self) -> Pattern<R>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<R: Debug> Debug for Pattern<R>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T, U> Foldable<T, U> for Pattern<T>

§

type Mapped = Pattern<U>

source§

fn fold<F: Fold<T, TargetU = U> + ?Sized>( self, folder: &mut F ) -> Result<Self::Mapped, F::Error>

source§

impl<R> From<Pattern<R>> for Ast<R>

source§

fn from(node: Pattern<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchAs<R>> for Pattern<R>

source§

fn from(payload: PatternMatchAs<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchClass<R>> for Pattern<R>

source§

fn from(payload: PatternMatchClass<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchMapping<R>> for Pattern<R>

source§

fn from(payload: PatternMatchMapping<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchOr<R>> for Pattern<R>

source§

fn from(payload: PatternMatchOr<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchSequence<R>> for Pattern<R>

source§

fn from(payload: PatternMatchSequence<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchSingleton<R>> for Pattern<R>

source§

fn from(payload: PatternMatchSingleton<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchStar<R>> for Pattern<R>

source§

fn from(payload: PatternMatchStar<R>) -> Self

Converts to this type from the input type.
source§

impl<R> From<PatternMatchValue<R>> for Pattern<R>

source§

fn from(payload: PatternMatchValue<R>) -> Self

Converts to this type from the input type.
source§

impl<R> Node for Pattern<R>

source§

const NAME: &'static str = "pattern"

source§

const FIELD_NAMES: &'static [&'static str] = _

source§

impl<R: PartialEq> PartialEq for Pattern<R>

source§

fn eq(&self, other: &Pattern<R>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl Ranged for Pattern

§

fn range(&self) -> TextRange

source§

fn start(&self) -> TextSize

source§

fn end(&self) -> TextSize

source§

impl<R> StructuralPartialEq for Pattern<R>

Auto Trait Implementations§

§

impl<R> Freeze for Pattern<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for Pattern<R>
where R: RefUnwindSafe,

§

impl<R> Send for Pattern<R>
where R: Send,

§

impl<R> Sync for Pattern<R>
where R: Sync,

§

impl<R> Unpin for Pattern<R>
where R: Unpin,

§

impl<R> UnwindSafe for Pattern<R>
where R: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

source§

fn exact_from(value: T) -> U

source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

source§

fn exact_into(self) -> U

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

source§

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

source§

impl<T> ToDebugString for T
where T: Debug,

source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

source§

fn wrapping_into(self) -> U