Struct TypeExpression 

pub struct TypeExpression { /* private fields */ }

A rendered type expression. Kept in pieces rather than as a string so that references to other pages can become links, while everything around them is rendered as inline code.

Implementations

impl TypeExpression

pub fn code(value: impl Into<String>) -> Self

Create an expression from a piece of code.

pub fn reference(name: impl Into<String>) -> Self

Create an expression that refers to another type by name.

pub fn join<I>(exprs: I, separator: &str) -> Self

where I: IntoIterator<Item = TypeExpression>,

Join expressions with a separator.

pub fn push_code(&mut self, value: impl Into<String>)

Append a piece of code.

pub fn extend(&mut self, other: TypeExpression)

Append another expression.

pub fn parenthesize(self) -> Self

Wrap the expression in parentheses.

pub fn is_union(&self) -> bool

Return true if the expression is a union of types.

pub fn is_reference(&self) -> bool

Return true if the expression is nothing but a reference to a type.

pub fn references(&self) -> Vec<&str>

The types the expression refers to, in order of first appearance.

Trait Implementations

impl Clone for TypeExpression

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeExpression

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

Formats the value using the given formatter.

impl Default for TypeExpression

fn default() -> Self

Returns the “default value” for a type.

impl Display for TypeExpression

The expression as plain text, with references reduced to their names.

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

Formats the value using the given formatter.

impl PartialEq for TypeExpression

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

Equality operator ==.

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

Inequality operator !=.

impl SchemaRenderer<TypeExpression> for ApiDocsRenderer

fn is_reference(&self, name: &str) -> bool

Return true of the provided name is a referenced type.

fn render_array( &mut self, array: &ArrayType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render an ArrayType to a string.

fn render_boolean( &mut self, _boolean: &BooleanType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a boolean type to a string.

fn render_enum( &mut self, enu: &EnumType, schema: &Schema, ) -> RenderResult<TypeExpression>

Render an EnumType to a string.

fn render_float( &mut self, _float: &FloatType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a FloatType to a string.

fn render_integer( &mut self, _integer: &IntegerType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render an IntegerType to a string.

fn render_literal( &mut self, literal: &LiteralType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a LiteralType to a string.

fn render_null(&mut self, _schema: &Schema) -> RenderResult<TypeExpression>

Render a null type to a string.

fn render_object( &mut self, object: &ObjectType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render an ObjectType to a string.

fn render_reference( &mut self, reference: &str, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a referenced type to a string.

fn render_string( &mut self, _string: &StringType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a StringType to a string.

fn render_struct( &mut self, structure: &StructType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a StructType to a string.

fn render_tuple( &mut self, tuple: &TupleType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a TupleType to a string.

fn render_union( &mut self, uni: &UnionType, _schema: &Schema, ) -> RenderResult<TypeExpression>

Render a UnionType to a string.

fn render_unknown(&mut self, _schema: &Schema) -> RenderResult<TypeExpression>

Render an unknown type to a string.

fn render(&mut self, schemas: IndexMap<String, Schema>) -> RenderResult

Render the list of Schemas to a string, in the order they are listed. References between types can be resolved using the provided schemas map.

fn render_schema(&mut self, schema: &Schema) -> RenderResult<O>

Render all possible variants of the provided Schema to a string. If a variant has an explicit name, and that name is a reference, return the name instead of rendering the type.

fn render_schema_without_reference( &mut self, schema: &Schema, ) -> RenderResult<O>

Like Self::render_schema but does not check for references.

impl StructuralPartialEq for TypeExpression