sphinx_ultra::directives::validation::builtin

Struct TocTreeValidator

pub struct TocTreeValidator;

Expand description

Validator for toctree directive

Implementations§

impl TocTreeValidator

pub fn new() -> Self

Trait Implementations§

impl Default for TocTreeValidator

fn default() -> TocTreeValidator

Returns the “default value” for a type. Read more

impl DirectiveValidator for TocTreeValidator

fn name(&self) -> &str

Returns the name of the directive this validator handles

fn validate(&self, directive: &ParsedDirective) -> DirectiveValidationResult

Validates a parsed directive

fn expected_arguments(&self) -> Vec<String>

Returns expected arguments for this directive

fn valid_options(&self) -> Vec<String>

Returns valid options for this directive

fn requires_content(&self) -> bool

Returns whether this directive requires content

fn allows_content(&self) -> bool

Returns whether this directive allows content

fn get_suggestions(&self, directive: &ParsedDirective) -> Vec<String>

Provides suggestions for fixing directive issues

Auto Trait Implementations§

impl Freeze for TocTreeValidator

impl RefUnwindSafe for TocTreeValidator

impl Send for TocTreeValidator

impl Sync for TocTreeValidator

impl Unpin for TocTreeValidator

impl UnwindSafe for TocTreeValidator

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.