Struct ModuleId 

pub struct ModuleId(/* private fields */);

The id of a module.

Can be parsed using std::str::FromStr. May only contain alphanumeric ascii characters.

Implementations

impl ModuleId

pub fn is_default(&self) -> bool

Check whether this module id is the default module id identified by DEFAULT_MODULE_ID.

pub fn as_str(&self) -> &str

Get the &str reference to the module id

pub const fn example_data() -> ModuleId

Get an example instance of the ModuleId.

Trait Implementations

impl<'__expr> AsExpression<Nullable<Text>> for &'__expr ModuleId

type Expression = Bound<Nullable<Text>, &'__expr ModuleId>

The expression being returned

fn as_expression( self, ) -> <&'__expr ModuleId as AsExpression<Nullable<Text>>>::Expression

Perform the conversion

impl AsExpression<Nullable<Text>> for ModuleId

type Expression = Bound<Nullable<Text>, ModuleId>

The expression being returned

fn as_expression(self) -> <ModuleId as AsExpression<Nullable<Text>>>::Expression

Perform the conversion

impl<'__expr> AsExpression<Text> for &'__expr ModuleId

type Expression = Bound<Text, &'__expr ModuleId>

The expression being returned

fn as_expression(self) -> <&'__expr ModuleId as AsExpression<Text>>::Expression

Perform the conversion

impl AsExpression<Text> for ModuleId

type Expression = Bound<Text, ModuleId>

The expression being returned

fn as_expression(self) -> <ModuleId as AsExpression<Text>>::Expression

Perform the conversion

impl Clone for ModuleId

fn clone(&self) -> ModuleId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleId

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

Formats the value using the given formatter.

impl Default for ModuleId

fn default() -> ModuleId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleId

where ModuleId: FromStr, <ModuleId as FromStr>::Err: Display,

fn deserialize<__D>( deserializer: __D, ) -> Result<ModuleId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DieselNewtype<Text> for ModuleId

impl Display for ModuleId

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

Formats the value using the given formatter.

impl Eq for ModuleId

impl ExampleData for ModuleId

fn example_data() -> Self

Get an example instance of the current datatype.

impl<DB> FromSql<Text, DB> for ModuleId

where DB: Backend, Identifier: FromSql<Text, DB>,

fn from_sql( raw: <DB as Backend>::RawValue<'_>, ) -> Result<ModuleId, Box<dyn Error + Send + Sync>>

See the trait documentation.

fn from_nullable_sql( raw: Option<<DB as Backend>::RawValue<'_>>, ) -> Result<ModuleId, Box<dyn Error + Send + Sync>>

A specialized variant of from_sql for handling null values.

impl FromStr for ModuleId

type Err = ParseModuleIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ModuleId, <ModuleId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ModuleId

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ModuleId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModuleId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ModuleId

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialSchema for ModuleId

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl<__DB, __ST> Queryable<__ST, __DB> for ModuleId

where __DB: Backend, __ST: SingleValue, ModuleId: FromSql<__ST, __DB>,

type Row = ModuleId

The Rust type you’d like to map from.

fn build(row: ModuleId) -> Result<ModuleId, Box<dyn Error + Send + Sync>>

Construct an instance of this type

impl Serialize for ModuleId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModuleId

impl TS for ModuleId

type WithoutGenerics = ModuleId

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ModuleId

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where ModuleId: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where ModuleId: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl ToSchema for ModuleId

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

fn name() -> Cow<'static, str>

Return name of the schema.

impl<__DB> ToSql<Nullable<Text>, __DB> for ModuleId

where __DB: Backend, ModuleId: ToSql<Text, __DB>,

fn to_sql<'__b>( &'__b self, out: &mut Output<'__b, '_, __DB>, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

See the trait documentation.

impl<DB> ToSql<Text, DB> for ModuleId

where DB: Backend, Identifier: ToSql<Text, DB>,

fn to_sql<'b>( &'b self, out: &mut Output<'b, '_, DB>, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

See the trait documentation.

impl TryFrom<&'static str> for ModuleId

type Error = ParseModuleIdError

The type returned in the event of a conversion error.

fn try_from( value: &'static str, ) -> Result<ModuleId, <ModuleId as TryFrom<&'static str>>::Error>

Performs the conversion.

impl TryFrom<String> for ModuleId

type Error = ParseModuleIdError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ModuleId, <ModuleId as TryFrom<String>>::Error>

Performs the conversion.