Struct Never 

pub struct Never<T = ()>(/* private fields */);

Cast a Rust type to a Typescript never type.

Examples

This can be used as a type override.

use serde::Serialize;
use specta::Type;
use specta_typescript::Never;

#[derive(Serialize, Type)]
pub struct Demo {
    #[specta(type = Never)]
    pub field: String,
}

Or it can be used as a wrapper type.

use serde::Serialize;
use specta::Type;
use specta_typescript::Never;

#[derive(Serialize, Type)]
pub struct Demo {
    pub field: Never<String>,
}

Trait Implementations

impl<T: Clone> Clone for Never<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Never<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Never<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Serialize> Serialize for Never<T>

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Type for Never<T>

fn definition(_: &mut TypeCollection) -> DataType

returns a DataType that represents the type. This will also register this and any dependent types into the TypeCollection.