Struct pulldown_cmark::Options

source · [−]

pub struct Options { /* private fields */ }

Expand description

Option struct containing flags for enabling extra features that are not part of the CommonMark spec.

Implementations

source

pub const fn empty() -> Options

Returns an empty set of flags

source

pub const fn all() -> Options

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

pub fn from_bits(bits: u32) -> Option<Options>

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

source

pub const fn from_bits_truncate(bits: u32) -> Options

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

source

pub const unsafe fn from_bits_unchecked(bits: u32) -> Options

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

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

source

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

Removes the specified flags in-place.

source

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

Toggles the specified flags in-place.

source

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

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

Trait Implementations

source

impl Binary for Options

source

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

Formats the value using the given formatter.

source

impl BitAnd<Options> for Options

source

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

Returns the intersection between the two sets of flags.

type Output = Options

The resulting type after applying the & operator.

source

impl BitAndAssign<Options> for Options

source

fn bitand_assign(&mut self, other: Options)

Disables all flags disabled in the set.

source

impl BitOr<Options> for Options

source

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

Returns the union of the two sets of flags.

type Output = Options

The resulting type after applying the | operator.

source

impl BitOrAssign<Options> for Options

source

fn bitor_assign(&mut self, other: Options)

Adds the set of flags.

source

impl BitXor<Options> for Options

source

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

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

type Output = Options

The resulting type after applying the ^ operator.

source

impl BitXorAssign<Options> for Options

source

fn bitxor_assign(&mut self, other: Options)

Toggles the set of flags.

source

impl Clone for Options

source

fn clone(&self) -> Options

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 Debug for Options

source

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

Formats the value using the given formatter. Read more

source

impl Extend<Options> for Options

source

fn extend<T: IntoIterator<Item = Options>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more

source

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

source

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. Read more

source

impl FromIterator<Options> for Options

source

fn from_iter<T: IntoIterator<Item = Options>>(iterator: T) -> Options

Creates a value from an iterator. Read more

source

impl Hash for Options

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl LowerHex for Options

source

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

Formats the value using the given formatter.

source

impl Not for Options

source

fn not(self) -> Options

Returns the complement of this set of flags.

type Output = Options

The resulting type after applying the ! operator.

source

impl Octal for Options

source

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

Formats the value using the given formatter.

source

impl Ord for Options

source

fn cmp(&self, other: &Options) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl PartialEq<Options> for Options

source

fn eq(&self, other: &Options) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl PartialOrd<Options> for Options

source

fn partial_cmp(&self, other: &Options) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl Sub<Options> for Options

source

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

Returns the set difference of the two sets of flags.

type Output = Options

The resulting type after applying the - operator.

source

impl SubAssign<Options> for Options

source

fn sub_assign(&mut self, other: Options)

Disables all flags enabled in the set.

source

impl UpperHex for Options

source

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

Formats the value using the given formatter.

source

impl Copy for Options

source

impl Eq for Options

source

impl StructuralEq for Options

source

impl StructuralPartialEq for Options

Auto Trait Implementations

impl RefUnwindSafe for Options

impl Send for Options

impl Sync for Options

impl Unpin for Options

impl UnwindSafe for Options

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct pulldown_cmark::Options

Implementations

impl Options

pub const ENABLE_TABLES: Options

pub const ENABLE_FOOTNOTES: Options

pub const ENABLE_STRIKETHROUGH: Options

pub const ENABLE_TASKLISTS: Options

pub const ENABLE_SMART_PUNCTUATION: Options

pub const fn empty() -> Options

pub const fn all() -> Options

pub const fn bits(&self) -> u32

pub fn from_bits(bits: u32) -> Option<Options>

pub const fn from_bits_truncate(bits: u32) -> Options

pub const unsafe fn from_bits_unchecked(bits: u32) -> Options

pub const fn is_empty(&self) -> bool

pub const fn is_all(&self) -> bool

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

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

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

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

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

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

Trait Implementations

impl Binary for Options

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

impl BitAnd<Options> for Options

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

type Output = Options

impl BitAndAssign<Options> for Options

fn bitand_assign(&mut self, other: Options)

impl BitOr<Options> for Options

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

type Output = Options

impl BitOrAssign<Options> for Options

fn bitor_assign(&mut self, other: Options)

impl BitXor<Options> for Options

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

type Output = Options

impl BitXorAssign<Options> for Options

fn bitxor_assign(&mut self, other: Options)

impl Clone for Options

fn clone(&self) -> Options

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

impl Debug for Options

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

impl Extend<Options> for Options

fn extend<T: IntoIterator<Item = Options>>(&mut self, iterator: T)

fn extend_one(&mut self, item: A)

fn extend_reserve(&mut self, additional: usize)

impl FromIterator<Options> for Options

fn from_iter<T: IntoIterator<Item = Options>>(iterator: T) -> Options

impl Hash for Options

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

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl LowerHex for Options

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

impl Not for Options

fn not(self) -> Options

type Output = Options

impl Octal for Options

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

impl Ord for Options

fn cmp(&self, other: &Options) -> Ordering

fn max(self, other: Self) -> Self

fn min(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl PartialEq<Options> for Options

fn eq(&self, other: &Options) -> bool

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

impl PartialOrd<Options> for Options

fn partial_cmp(&self, other: &Options) -> Option<Ordering>

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

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

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

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

impl Sub<Options> for Options

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

type Output = Options

impl SubAssign<Options> for Options

fn sub_assign(&mut self, other: Options)

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

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

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

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

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

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

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

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

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