Skip to content

cargo_wiki

Jump to bottom
GitHub Action edited this page Feb 15, 2025 · 15 revisions

cargo_wiki

Modules

Structs

Enums

Configuration

pub struct Configuration {
	pub package: String,
	pub workspace: bool,
	pub features: String,
	pub all_features: bool,
	pub no_default_features: bool,
	pub document_private_items: bool,
	pub no_deps: bool,
	pub markdown_flavor: MarkdownFlavor,
	pub structure: WikiStructure,
	pub default_link_file_extension: String,
	pub default_module_file_name: String,
	pub html_root_url: String,
}
Fields

  • package : String

    The package to document. See cargo-pkgid for the SPEC format.

  • workspace : bool

  • features : String

    Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

  • all_features : bool

    Activate all available features of all selected packages.

  • no_default_features : bool

    Do not activate the default feature of the selected packages.

  • document_private_items : bool

  • no_deps : bool

  • markdown_flavor : MarkdownFlavor

  • structure : WikiStructure

  • default_link_file_extension : String

    Sets the default file extension that will be used for all links. This doesn't change file type.

  • default_module_file_name : String

    Sets the default file name for module files

  • html_root_url : String

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Configuration

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl Parser for Configuration

impl CommandFactory for Configuration

fn command<'b>() -> Command;
fn command_for_update<'b>() -> Command;

impl FromArgMatches for Configuration

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>;
fn from_arg_matches_mut(__clap_arg_matches: &mut ArgMatches) -> Result<Self, Error>;
fn update_from_arg_matches(self: &mut Self, __clap_arg_matches: &ArgMatches) -> Result<(), Error>;
fn update_from_arg_matches_mut(self: &mut Self, __clap_arg_matches: &mut ArgMatches) -> Result<(), Error>;

impl Args for Configuration

fn group_id() -> Option<Id>;
fn augment_args<'b>(__clap_app: Command) -> Command;
fn augment_args_for_update<'b>(__clap_app: Command) -> Command;

impl Debug for Configuration

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

Auto Trait Implementations

impl Send for Configuration

impl Sync for Configuration

impl Freeze for Configuration

impl Unpin for Configuration

impl UnwindSafe for Configuration

impl RefUnwindSafe for Configuration

MarkdownFlavor

pub enum MarkdownFlavor {
	GitHub,
	GitLab,
}

Markdown Flavor to be used

Variants

  • GitHub

    GitHub Markdown Flavor

  • GitLab

    GitLab Markdown Flavor

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for MarkdownFlavor where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for MarkdownFlavor

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for MarkdownFlavor where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for MarkdownFlavor where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for MarkdownFlavor

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

impl ValueEnum for MarkdownFlavor

fn value_variants<'a>() -> &'a [Self];
fn to_possible_value<'a>(self: &Self) -> Option<PossibleValue>;

impl Clone for MarkdownFlavor

fn clone(self: &Self) -> MarkdownFlavor;

impl StructuralPartialEq for MarkdownFlavor

impl PartialEq for MarkdownFlavor

fn eq(self: &Self, other: &MarkdownFlavor) -> bool;

Auto Trait Implementations

impl Send for MarkdownFlavor

impl Sync for MarkdownFlavor

impl Freeze for MarkdownFlavor

impl Unpin for MarkdownFlavor

impl UnwindSafe for MarkdownFlavor

impl RefUnwindSafe for MarkdownFlavor

WikiStructure

pub enum WikiStructure {
	Directory,
	SingleFile,
}

Structure of the wiki

Variants

  • Directory

    Structure via directory. This will create multiple directories.

  • SingleFile

    A Single file for the entire crate.

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for WikiStructure where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for WikiStructure

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for WikiStructure where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for WikiStructure where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for WikiStructure

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

impl ValueEnum for WikiStructure

fn value_variants<'a>() -> &'a [Self];
fn to_possible_value<'a>(self: &Self) -> Option<PossibleValue>;

impl Clone for WikiStructure

fn clone(self: &Self) -> WikiStructure;

impl StructuralPartialEq for WikiStructure

impl PartialEq for WikiStructure

fn eq(self: &Self, other: &WikiStructure) -> bool;

Auto Trait Implementations

impl Send for WikiStructure

impl Sync for WikiStructure

impl Freeze for WikiStructure

impl Unpin for WikiStructure

impl UnwindSafe for WikiStructure

impl RefUnwindSafe for WikiStructure

_examples

Modules

struct_examples

Structs

UnitStruct

pub struct UnitStruct;
Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for UnitStruct

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for UnitStruct

impl Sync for UnitStruct

impl Freeze for UnitStruct

impl Unpin for UnitStruct

impl UnwindSafe for UnitStruct

impl RefUnwindSafe for UnitStruct

TupleStruct

pub struct TupleStruct(i32, u64, Basic)
Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for TupleStruct

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for TupleStruct

impl Sync for TupleStruct

impl Freeze for TupleStruct

impl Unpin for TupleStruct

impl UnwindSafe for TupleStruct

impl RefUnwindSafe for TupleStruct

Basic

pub struct Basic {
	pub type_: String,
	pub type: String,
}

This is a very basic struct

Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Basic

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for Basic

impl Sync for Basic

impl Freeze for Basic

impl Unpin for Basic

impl UnwindSafe for Basic

impl RefUnwindSafe for Basic

ComplexStruct

pub struct ComplexStruct<'a, T: 'a + ?Sized, U: Default = i32> {
	pub reference: &'a T,
	pub value: U,
	pub slice: &'a [u32; 50],
}
Fields

  • reference : &'a T

    This is a reference

  • value : U

  • slice : &'a [u32; 50]

Implementations

Trait Implementations

impl<T> Borrow<T> for ComplexStruct<'a, T, U> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for ComplexStruct<'a, T, U> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T, U> Into<U> for ComplexStruct<'a, T, U> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ComplexStruct<'a, T, U>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for ComplexStruct<'a, T, U> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for ComplexStruct<'a, T, U> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl<'a, T, U> Send for ComplexStruct<'a, T, U> where U: Send, T: Sync + ?Sized

impl<'a, T, U> Sync for ComplexStruct<'a, T, U> where U: Sync, T: Sync + ?Sized

impl<'a, T, U> Freeze for ComplexStruct<'a, T, U> where U: Freeze, T: ?Sized

impl<'a, T, U> Unpin for ComplexStruct<'a, T, U> where U: Unpin, T: ?Sized

impl<'a, T, U> UnwindSafe for ComplexStruct<'a, T, U> where U: UnwindSafe, T: RefUnwindSafe + ?Sized

impl<'a, T, U> RefUnwindSafe for ComplexStruct<'a, T, U> where U: RefUnwindSafe, T: RefUnwindSafe + ?Sized

PredicateStruct

pub struct PredicateStruct<'a, T, U>
where
	T: 'a + ?Sized,
	U: Default
{	pub reference: &'a T,
	pub value: U,
	/* private fields */
}
Fields
  • reference : &'a T
  • value : U

Implementations

Trait Implementations

impl<T> Borrow<T> for PredicateStruct<'a, T, U> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for PredicateStruct<'a, T, U> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T, U> Into<U> for PredicateStruct<'a, T, U> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for PredicateStruct<'a, T, U>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for PredicateStruct<'a, T, U> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for PredicateStruct<'a, T, U> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl<'a, T, U> Send for PredicateStruct<'a, T, U> where U: Send, T: Sync + ?Sized

impl<'a, T, U> Sync for PredicateStruct<'a, T, U> where U: Sync, T: Sync + ?Sized

impl<'a, T, U> Freeze for PredicateStruct<'a, T, U> where U: Freeze, T: ?Sized

impl<'a, T, U> Unpin for PredicateStruct<'a, T, U> where U: Unpin, T: ?Sized

impl<'a, T, U> UnwindSafe for PredicateStruct<'a, T, U> where U: UnwindSafe, T: RefUnwindSafe + ?Sized

impl<'a, T, U> RefUnwindSafe for PredicateStruct<'a, T, U> where U: RefUnwindSafe, T: RefUnwindSafe + ?Sized

HRTBPredicateStruct

pub struct HRTBPredicateStruct<'a, T, U, F>
where
	for<'b> T: 'b + ?Sized,
	U: Default,
	F: FnFn(&'a T) -> U
{	pub reference: &'a T,
	pub value: U,
	pub transformer: F,
	/* private fields */
}

Uses Higher-Rank Trait Bounds (HRTBs)

Fields
  • reference : &'a T
  • value : U
  • transformer : F

Implementations

Trait Implementations

impl<T> Borrow<T> for HRTBPredicateStruct<'a, T, U, F> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for HRTBPredicateStruct<'a, T, U, F> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T, U> Into<U> for HRTBPredicateStruct<'a, T, U, F> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for HRTBPredicateStruct<'a, T, U, F>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for HRTBPredicateStruct<'a, T, U, F> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for HRTBPredicateStruct<'a, T, U, F> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

impl<T> Any for HRTBPredicateStruct<'a, T, U, F> where T: 'static + ?Sized

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl<'a, T, U, F> Send for HRTBPredicateStruct<'a, T, U, F> where U: Send, F: Send, T: Sync + ?Sized

impl<'a, T, U, F> Sync for HRTBPredicateStruct<'a, T, U, F> where U: Sync, F: Sync, T: Sync + ?Sized

impl<'a, T, U, F> Freeze for HRTBPredicateStruct<'a, T, U, F> where U: Freeze, F: Freeze, T: ?Sized

impl<'a, T, U, F> Unpin for HRTBPredicateStruct<'a, T, U, F> where U: Unpin, F: Unpin, T: ?Sized

impl<'a, T, U, F> UnwindSafe for HRTBPredicateStruct<'a, T, U, F> where U: UnwindSafe, F: UnwindSafe, T: RefUnwindSafe + ?Sized

impl<'a, T, U, F> RefUnwindSafe for HRTBPredicateStruct<'a, T, U, F> where U: RefUnwindSafe, F: RefUnwindSafe, T: RefUnwindSafe + ?Sized

enum_examples

Enums

  • Direction

    An enumeration for directions

  • TrafficLight

    An enumeration for traffic light states

  • Weather

    An enumeration representing different types of wea

  • Status

    An enumeration for result status

Direction

pub enum Direction {
	North,
	South,
	East,
	West,
}

An enumeration for directions

Variants

  • North

    Points North

  • South

    Points South

  • East

    Points East

  • West

    Points West

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Direction

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl Debug for Direction

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

impl StructuralPartialEq for Direction

impl PartialEq for Direction

fn eq(self: &Self, other: &Direction) -> bool;

Auto Trait Implementations

impl Send for Direction

impl Sync for Direction

impl Freeze for Direction

impl Unpin for Direction

impl UnwindSafe for Direction

impl RefUnwindSafe for Direction

TrafficLight

pub enum TrafficLight {
	Red,
	Yellow,
	Green,
}

An enumeration for traffic light states

Variants

  • Red

    Red light - Stop

  • Yellow

    Yellow light - Caution

  • Green

    Green light - Go

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for TrafficLight

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl Debug for TrafficLight

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

Auto Trait Implementations

impl Send for TrafficLight

impl Sync for TrafficLight

impl Freeze for TrafficLight

impl Unpin for TrafficLight

impl UnwindSafe for TrafficLight

impl RefUnwindSafe for TrafficLight

Weather

pub enum Weather {
	Sunny(0),
	Rainy(0),
	Cloudy,
	Snowy(0),
}

An enumeration representing different types of weather

Variants

  • Sunny

    Sunny weather with optional temperature

  • Rainy

    Rainy weather with precipitation amount

  • Cloudy

    Cloudy weather

  • Snowy

    Snowy weather with snowfall amount

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Weather

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl Debug for Weather

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

Auto Trait Implementations

impl Send for Weather

impl Sync for Weather

impl Freeze for Weather

impl Unpin for Weather

impl UnwindSafe for Weather

impl RefUnwindSafe for Weather

Status

pub enum Status<T, E> {
	Success(0),
	Failure(0),
	Pending,
}

An enumeration for result status

Variants

  • Success

    Operation succeeded with value

  • Failure

    Operation failed with error

  • Pending

    Operation pending

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Status<T, E>

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T: Debug, E: Debug> Debug for Status<T, E>

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

Auto Trait Implementations

impl<T, E> Send for Status<T, E> where T: Send, E: Send

impl<T, E> Sync for Status<T, E> where T: Sync, E: Sync

impl<T, E> Freeze for Status<T, E> where T: Freeze, E: Freeze

impl<T, E> Unpin for Status<T, E> where T: Unpin, E: Unpin

impl<T, E> UnwindSafe for Status<T, E> where T: UnwindSafe, E: UnwindSafe

impl<T, E> RefUnwindSafe for Status<T, E> where T: RefUnwindSafe, E: RefUnwindSafe

blocks

Modules

Structs

GroupBlock

pub struct GroupBlock {
	/* private fields */
}
Fields

Implementations

fn new() -> Self;
fn push<E>(self: &mut Self, element: E)
where
	E: ToMarkdown + 'static;
fn push_c<E>(self: Self, element: E) -> Self
where
	E: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for GroupBlock where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for GroupBlock

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for GroupBlock where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for GroupBlock where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for GroupBlock

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

impl Clone for GroupBlock

fn clone(self: &Self) -> GroupBlock;

impl ToMarkdown for GroupBlock

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for GroupBlock

impl !Sync for GroupBlock

impl Freeze for GroupBlock

impl Unpin for GroupBlock

impl !UnwindSafe for GroupBlock

impl !RefUnwindSafe for GroupBlock

RawBlock

pub struct RawBlock(/* private field */)
Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for RawBlock where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for RawBlock

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for RawBlock where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for RawBlock where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for RawBlock

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

impl Clone for RawBlock

fn clone(self: &Self) -> RawBlock;

impl From<String> for RawBlock

fn from(value: String) -> Self;

impl From<&String> for RawBlock

fn from(value: &String) -> Self;

impl From<&str> for RawBlock

fn from(value: &str) -> Self;

impl ToMarkdown for RawBlock

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for RawBlock

impl Sync for RawBlock

impl Freeze for RawBlock

impl Unpin for RawBlock

impl UnwindSafe for RawBlock

impl RefUnwindSafe for RawBlock

EmptyElement

pub struct EmptyElement;
Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for EmptyElement where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for EmptyElement

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for EmptyElement where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for EmptyElement where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for EmptyElement

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

impl Clone for EmptyElement

fn clone(self: &Self) -> EmptyElement;

impl ToMarkdown for EmptyElement

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for EmptyElement

impl Sync for EmptyElement

impl Freeze for EmptyElement

impl Unpin for EmptyElement

impl UnwindSafe for EmptyElement

impl RefUnwindSafe for EmptyElement

NLines

pub struct NLines(/* private field */)
Fields

Implementations

fn new(n_lines: u8) -> Self;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for NLines where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for NLines

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for NLines where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for NLines where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for NLines

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

impl Clone for NLines

fn clone(self: &Self) -> NLines;

impl ToMarkdown for NLines

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for NLines

impl Sync for NLines

impl Freeze for NLines

impl Unpin for NLines

impl UnwindSafe for NLines

impl RefUnwindSafe for NLines

Title

pub struct Title(/* private field */, /* private field */)
Fields

Implementations

fn new<E>(level: u8, element: E) -> Self
where
	E: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Title where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Title

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Title where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Title where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Title

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

impl Clone for Title

fn clone(self: &Self) -> Title;

impl ToMarkdown for Title

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for Title

impl !Sync for Title

impl Freeze for Title

impl Unpin for Title

impl !UnwindSafe for Title

impl !RefUnwindSafe for Title

ListBlock

pub struct ListBlock {
	/* private fields */
}
Fields

Implementations

fn new_ordered_list() -> Self;
fn new_unordered_list() -> Self;
fn push<N, D>(self: &mut Self, item_name: N, item_description: D)
where
	N: ToMarkdown + 'static,
	D: ToMarkdown + 'static;
fn push_c<N, D>(self: Self, item_name: N, item_description: D) -> Self
where
	N: ToMarkdown + 'static,
	D: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for ListBlock where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ListBlock

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for ListBlock where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for ListBlock where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for ListBlock

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

impl Clone for ListBlock

fn clone(self: &Self) -> ListBlock;

impl ToMarkdown for ListBlock

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for ListBlock

impl !Sync for ListBlock

impl Freeze for ListBlock

impl Unpin for ListBlock

impl !UnwindSafe for ListBlock

impl !RefUnwindSafe for ListBlock

DropDown

pub struct DropDown {
	/* private fields */
}
Fields

Implementations

fn new_closed<S, I>(summary: S, inner: I) -> Self
where
	S: ToMarkdown + 'static,
	I: ToMarkdown + 'static;
fn new_opened<S, I>(summary: S, inner: I) -> Self
where
	S: ToMarkdown + 'static,
	I: ToMarkdown + 'static;
fn push<S, I>(self: &mut Self, inner: I)
where
	S: ToMarkdown + 'static,
	I: ToMarkdown + 'static;
fn push_c<I>(self: Self, inner: I) -> Self
where
	I: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for DropDown where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for DropDown

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for DropDown where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for DropDown where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for DropDown

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

impl Clone for DropDown

fn clone(self: &Self) -> DropDown;

impl ToMarkdown for DropDown

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for DropDown

impl !Sync for DropDown

impl Freeze for DropDown

impl Unpin for DropDown

impl !UnwindSafe for DropDown

impl !RefUnwindSafe for DropDown

inline

Structs

InlineGroup

pub struct InlineGroup {
	/* private fields */
}
Fields

Implementations

fn new() -> Self;
fn push<E>(self: &mut Self, element: E)
where
	E: ToMarkdown + 'static;
fn push_c<E>(self: Self, element: E) -> Self
where
	E: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for InlineGroup where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for InlineGroup

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for InlineGroup where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for InlineGroup where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for InlineGroup

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

impl Clone for InlineGroup

fn clone(self: &Self) -> InlineGroup;

impl ToMarkdown for InlineGroup

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for InlineGroup

impl !Sync for InlineGroup

impl Freeze for InlineGroup

impl Unpin for InlineGroup

impl !UnwindSafe for InlineGroup

impl !RefUnwindSafe for InlineGroup

Space

pub struct Space(/* private field */)
Fields

Implementations

fn new(n_times: u8) -> Self;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Space where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Space

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Space where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Space where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Space

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

impl Clone for Space

fn clone(self: &Self) -> Space;

impl ToMarkdown for Space

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for Space

impl Sync for Space

impl Freeze for Space

impl Unpin for Space

impl UnwindSafe for Space

impl RefUnwindSafe for Space

Text

pub struct Text(/* private field */)
Fields

Implementations

fn new(text: String) -> Self;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Text where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Text

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Text where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Text where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Text

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

impl Clone for Text

fn clone(self: &Self) -> Text;

impl From<String> for Text

fn from(value: String) -> Self;

impl From<&String> for Text

fn from(value: &String) -> Self;

impl From<&str> for Text

fn from(value: &str) -> Self;

impl ToMarkdown for Text

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for Text

impl Sync for Text

impl Freeze for Text

impl Unpin for Text

impl UnwindSafe for Text

impl RefUnwindSafe for Text

Bold

pub struct Bold(/* private field */)
Fields

Implementations

fn new<E>(element: E) -> Self
where
	E: ToMarkdown + 'static;
fn push<E>(self: &mut Self, element: E)
where
	E: ToMarkdown + 'static;
fn push_c<E>(self: Self, element: E) -> Self
where
	E: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Bold where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Bold

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Bold where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Bold where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Bold

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

impl Clone for Bold

fn clone(self: &Self) -> Bold;

impl ToMarkdown for Bold

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for Bold

impl !Sync for Bold

impl Freeze for Bold

impl Unpin for Bold

impl !UnwindSafe for Bold

impl !RefUnwindSafe for Bold

Italic

pub struct Italic(/* private field */)
Fields

Implementations

fn new<E>(element: E) -> Self
where
	E: ToMarkdown + 'static;
fn push<E>(self: &mut Self, element: E)
where
	E: ToMarkdown + 'static;
fn push_c<E>(self: Self, element: E) -> Self
where
	E: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Italic where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Italic

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Italic where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Italic where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Italic

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

impl Clone for Italic

fn clone(self: &Self) -> Italic;

impl ToMarkdown for Italic

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for Italic

impl !Sync for Italic

impl Freeze for Italic

impl Unpin for Italic

impl !UnwindSafe for Italic

impl !RefUnwindSafe for Italic

Underline

pub struct Underline(/* private field */)
Fields

Implementations

fn new<E>(element: E) -> Self
where
	E: ToMarkdown + 'static;
fn push<E>(self: &mut Self, element: E)
where
	E: ToMarkdown + 'static;
fn push_c<E>(self: Self, element: E) -> Self
where
	E: ToMarkdown + 'static;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Underline where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Underline

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Underline where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Underline where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Underline

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

impl Clone for Underline

fn clone(self: &Self) -> Underline;

impl ToMarkdown for Underline

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl !Send for Underline

impl !Sync for Underline

impl Freeze for Underline

impl Unpin for Underline

impl !UnwindSafe for Underline

impl !RefUnwindSafe for Underline

CodeSpan

pub struct CodeSpan(/* private field */)
Fields

Implementations

fn new(code: String) -> Self;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for CodeSpan where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for CodeSpan

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for CodeSpan where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for CodeSpan where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for CodeSpan

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

impl Clone for CodeSpan

fn clone(self: &Self) -> CodeSpan;

impl From<String> for CodeSpan

fn from(value: String) -> Self;

impl From<&String> for CodeSpan

fn from(value: &String) -> Self;

impl From<&str> for CodeSpan

fn from(value: &str) -> Self;

impl ToMarkdown for CodeSpan

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for CodeSpan

impl Sync for CodeSpan

impl Freeze for CodeSpan

impl Unpin for CodeSpan

impl UnwindSafe for CodeSpan

impl RefUnwindSafe for CodeSpan

Link

pub struct Link(/* private field */, /* private field */)
Fields

Implementations

fn new(text: String, url: String) -> Self;
fn empty() -> Self;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for Link where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for Link

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for Link where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for Link where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl Debug for Link

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

impl Clone for Link

fn clone(self: &Self) -> Link;

impl ToMarkdown for Link

fn expects_new_line(self: &Self) -> bool;
fn to_markdown(self: &Self) -> String;

Auto Trait Implementations

impl Send for Link

impl Sync for Link

impl Freeze for Link

impl Unpin for Link

impl UnwindSafe for Link

impl RefUnwindSafe for Link

generators

Modules

enum_gen

Structs

EnumGenerator

pub struct EnumGenerator;
Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for EnumGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl Generator for EnumGenerator

fn generate_page(item: &Item, index: &Index, paths: &Paths, external_crates: &ExternalCrates, config: &Configuration) -> Result<Document>;

Auto Trait Implementations

impl Send for EnumGenerator

impl Sync for EnumGenerator

impl Freeze for EnumGenerator

impl Unpin for EnumGenerator

impl UnwindSafe for EnumGenerator

impl RefUnwindSafe for EnumGenerator

fn_gen

Structs

FunctionGenerator

pub struct FunctionGenerator;
Fields

Implementations

fn generate_syntax(function: &Function, name: &str) -> Result<String>;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for FunctionGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for FunctionGenerator

impl Sync for FunctionGenerator

impl Freeze for FunctionGenerator

impl Unpin for FunctionGenerator

impl UnwindSafe for FunctionGenerator

impl RefUnwindSafe for FunctionGenerator

generic_gen

Structs

GenericGenerator

pub struct GenericGenerator;
Fields

Implementations

fn generate_generics(generics: &Generics) -> Result<(, String)>;
fn generate_generic_params(generic_params: &Vec<GenericParamDef>) -> Result<String>;
fn generate_generic_bounds(bound: &GenericBound) -> Result<String>;
fn generate_generic_args(generic_args: &GenericArgs) -> String;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for GenericGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for GenericGenerator

impl Sync for GenericGenerator

impl Freeze for GenericGenerator

impl Unpin for GenericGenerator

impl UnwindSafe for GenericGenerator

impl RefUnwindSafe for GenericGenerator

impls_gen

Structs

ImplsGenerator

pub struct ImplsGenerator;
Fields

Implementations

fn generate_impls(impls: &Vec<Id>, index: &Index) -> Result<[Box<Document>; 3]>;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ImplsGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for ImplsGenerator

impl Sync for ImplsGenerator

impl Freeze for ImplsGenerator

impl Unpin for ImplsGenerator

impl UnwindSafe for ImplsGenerator

impl RefUnwindSafe for ImplsGenerator

module_gen

Structs

ModuleItems

pub struct ModuleItems<'a> {
	pub modules: Vec<ModuleField<'a>>,
	pub traits: Vec<ModuleField<'a>>,
	pub functions: Vec<ModuleField<'a>>,
	pub macros: Vec<ModuleField<'a>>,
	pub re_exports: Vec<ModuleField<'a>>,
	pub structs: Vec<ModuleField<'a>>,
	pub enums: Vec<ModuleField<'a>>,
	pub consts: Vec<ModuleField<'a>>,
}
Fields

Implementations

fn generate_docs(self: &Self) -> String;

Trait Implementations

impl<T> Borrow<T> for ModuleItems<'a> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for ModuleItems<'a> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for ModuleItems<'a> where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

impl<T, U> Into<U> for ModuleItems<'a> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ModuleItems<'a>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for ModuleItems<'a> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for ModuleItems<'a> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for ModuleItems<'a> where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for ModuleItems<'a> where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl<'a> Default for ModuleItems<'a>

fn default() -> ModuleItems<'a>;

impl<'a> Debug for ModuleItems<'a>

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

impl<'a> Clone for ModuleItems<'a>

fn clone(self: &Self) -> ModuleItems<'a>;

Auto Trait Implementations

impl<'a> Send for ModuleItems<'a>

impl<'a> Sync for ModuleItems<'a>

impl<'a> Freeze for ModuleItems<'a>

impl<'a> Unpin for ModuleItems<'a>

impl<'a> UnwindSafe for ModuleItems<'a>

impl<'a> RefUnwindSafe for ModuleItems<'a>

ModuleField

pub struct ModuleField<'a> {
	pub name: &'a str,
	pub link: String,
	pub description: &'a str,
}
Fields
  • name : &'a str
  • link : String
  • description : &'a str

Implementations

fn to_string(self: &Self) -> String;

Trait Implementations

impl<T> Borrow<T> for ModuleField<'a> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for ModuleField<'a> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for ModuleField<'a> where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

impl<T, U> Into<U> for ModuleField<'a> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ModuleField<'a>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for ModuleField<'a> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for ModuleField<'a> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for ModuleField<'a> where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for ModuleField<'a> where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl<'a> Debug for ModuleField<'a>

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

impl<'a> Clone for ModuleField<'a>

fn clone(self: &Self) -> ModuleField<'a>;

Auto Trait Implementations

impl<'a> Send for ModuleField<'a>

impl<'a> Sync for ModuleField<'a>

impl<'a> Freeze for ModuleField<'a>

impl<'a> Unpin for ModuleField<'a>

impl<'a> UnwindSafe for ModuleField<'a>

impl<'a> RefUnwindSafe for ModuleField<'a>

ModuleDocumentation

pub struct ModuleDocumentation<'a> {
	pub file_path: String,
	pub title: &'a str,
	pub module_items: ModuleItems<'a>,
	pub content: Vec<ModuleContent<'a>>,
	pub inner_modules: Vec<ModuleDocumentation<'a>>,
}
Fields

Implementations

fn generate_docs(self: &Self, configuration: &Configuration) -> Result<String>;

Trait Implementations

impl<T> Borrow<T> for ModuleDocumentation<'a> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for ModuleDocumentation<'a> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for ModuleDocumentation<'a> where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

impl<T, U> Into<U> for ModuleDocumentation<'a> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ModuleDocumentation<'a>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for ModuleDocumentation<'a> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for ModuleDocumentation<'a> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for ModuleDocumentation<'a> where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for ModuleDocumentation<'a> where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl<'a> Default for ModuleDocumentation<'a>

fn default() -> ModuleDocumentation<'a>;

impl<'a> Debug for ModuleDocumentation<'a>

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

impl<'a> Clone for ModuleDocumentation<'a>

fn clone(self: &Self) -> ModuleDocumentation<'a>;

Auto Trait Implementations

impl<'a> !Send for ModuleDocumentation<'a>

impl<'a> !Sync for ModuleDocumentation<'a>

impl<'a> Freeze for ModuleDocumentation<'a>

impl<'a> Unpin for ModuleDocumentation<'a>

impl<'a> !UnwindSafe for ModuleDocumentation<'a>

impl<'a> !RefUnwindSafe for ModuleDocumentation<'a>

ModuleContent

pub struct ModuleContent<'a> {
	pub file_path: String,
	pub kind: ItemKind,
	pub title: &'a str,
	pub inner: Document,
}
Fields

Implementations

fn save_to_file(self: &Self) -> Result<()>;

Trait Implementations

impl<T> Borrow<T> for ModuleContent<'a> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for ModuleContent<'a> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T> CloneToUninit for ModuleContent<'a> where T: Clone

unsafe fn clone_to_uninit(self: &Self, dst: *mut u8);

impl<T, U> Into<U> for ModuleContent<'a> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ModuleContent<'a>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for ModuleContent<'a> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for ModuleContent<'a> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl<T> ToOwned for ModuleContent<'a> where T: Clone

fn to_owned(self: &Self) -> T;
fn clone_into(self: &Self, target: &mut T);

impl<T> DynClone for ModuleContent<'a> where T: Clone

fn __clone_box(self: &Self, _: Private) -> *mut ();

impl<'a> Debug for ModuleContent<'a>

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

impl<'a> Clone for ModuleContent<'a>

fn clone(self: &Self) -> ModuleContent<'a>;

Auto Trait Implementations

impl<'a> !Send for ModuleContent<'a>

impl<'a> !Sync for ModuleContent<'a>

impl<'a> Freeze for ModuleContent<'a>

impl<'a> Unpin for ModuleContent<'a>

impl<'a> !UnwindSafe for ModuleContent<'a>

impl<'a> !RefUnwindSafe for ModuleContent<'a>

ModuleGenerator

pub struct ModuleGenerator<'a> {
	pub configuration: &'a Configuration,
	pub prefix_path: String,
	pub root_item: &'a Item,
	pub index: &'a Index,
	pub paths: &'a Paths,
	pub external_crate: &'a ExternalCrates,
}
Fields
  • configuration : &'a Configuration
  • prefix_path : String
  • root_item : &'a Item
  • index : &'a Index
  • paths : &'a Paths
  • external_crate : &'a ExternalCrates

Implementations

fn new(configuration: &'a Configuration, prefix_path: String, root_item: &'a Item, index: &'a Index, paths: &'a Paths, external_crate: &'a ExternalCrates) -> Self;
fn auto(self: Self) -> Result<ModuleDocumentation<'a>>;

Trait Implementations

impl<T> Borrow<T> for ModuleGenerator<'a> where T: ?Sized

fn borrow(self: &Self) -> &T;

impl<T> BorrowMut<T> for ModuleGenerator<'a> where T: ?Sized

fn borrow_mut(self: &mut Self) -> &mut T;

impl<T, U> Into<U> for ModuleGenerator<'a> where U: From<T>

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for ModuleGenerator<'a>

/// Returns the argument unchanged.
fn from(t: T) -> T;

impl<T, U> TryInto<U> for ModuleGenerator<'a> where U: TryFrom<T>

fn try_into(self: Self) -> Result<U, >;

impl<T, U> TryFrom<U> for ModuleGenerator<'a> where U: Into<T>

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl<'a> Send for ModuleGenerator<'a>

impl<'a> Sync for ModuleGenerator<'a>

impl<'a> Freeze for ModuleGenerator<'a>

impl<'a> Unpin for ModuleGenerator<'a>

impl<'a> UnwindSafe for ModuleGenerator<'a>

impl<'a> RefUnwindSafe for ModuleGenerator<'a>

struct_gen

Structs

StructGenerator

pub struct StructGenerator;
Fields

Implementations

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for StructGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

impl Generator for StructGenerator

/// Generate Code Syntax for `Struct`. See [Template.html](https://github.com/AS1100K/cargo-wiki/blob/main/Template.md#struct-syntax-block)
/// for more info.
fn generate_page(item: &Item, index: &Index, paths: &Paths, external_crates: &ExternalCrates, config: &Configuration) -> Result<Document>;

Auto Trait Implementations

impl Send for StructGenerator

impl Sync for StructGenerator

impl Freeze for StructGenerator

impl Unpin for StructGenerator

impl UnwindSafe for StructGenerator

impl RefUnwindSafe for StructGenerator

type_gen

Structs

TypeGenerator

pub struct TypeGenerator;
Fields

Implementations

fn type_to_string(type_: &Type) -> String;
fn type_to_link(type_: &Type, paths: &Paths, external_crates: &ExternalCrates, config: &Configuration) -> InlineGroup;
fn path_to_string(path: &Path) -> String;
fn item_summary_to_url(is_this_crate: bool, path: &ItemSummary, config: &Configuration) -> String;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for TypeGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for TypeGenerator

impl Sync for TypeGenerator

impl Freeze for TypeGenerator

impl Unpin for TypeGenerator

impl UnwindSafe for TypeGenerator

impl RefUnwindSafe for TypeGenerator

visibility_gen

Structs

VisibilityGenerator

pub struct VisibilityGenerator;
Fields

Implementations

fn generate_visibility(visibility: &Visibility) -> String;

Trait Implementations

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

fn borrow(self: &Self) -> &T;

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

fn borrow_mut(self: &mut Self) -> &mut T;

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

/// Calls `U::from(self)`.
/// 
/// That is, this conversion is whatever the implementation of
/// <code>[From]&lt;T&gt; for U</code> chooses to do.
fn into(self: Self) -> U;

impl<T> From<T> for VisibilityGenerator

/// Returns the argument unchanged.
fn from(t: T) -> T;

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

fn try_into(self: Self) -> Result<U, >;

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

fn try_from(value: U) -> Result<T, >;

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

fn type_id(self: &Self) -> TypeId;

Auto Trait Implementations

impl Send for VisibilityGenerator

impl Sync for VisibilityGenerator

impl Freeze for VisibilityGenerator

impl Unpin for VisibilityGenerator

impl UnwindSafe for VisibilityGenerator

impl RefUnwindSafe for VisibilityGenerator

rust_doc

wiki

Modules

generator

Clone this wiki locally