pub struct Dummy;Expand description
Dummy type used as a placeholder for generic parameters during codegen.
Trait Implementations§
Source§impl Flow for Dummy
impl Flow for Dummy
Source§type WithoutGenerics = Dummy
type WithoutGenerics = Dummy
If this type does not have generic parameters, then
WithoutGenerics should be Self.
If the type does have generic parameters, then all generic parameters must be replaced
with a dummy type, e.g flowjs_rs::Dummy or ().
The only requirement for these dummy types is that output_path() must return None.Source§type OptionInnerType = Dummy
type OptionInnerType = Dummy
If the implementing type is
std::option::Option<T>, then this associated type is set
to T. All other implementations of Flow should set this type to Self instead.Source§fn inline(_: &Config) -> String
fn inline(_: &Config) -> String
Inline Flow type definition (the right-hand side of
type X = ...).Source§fn docs() -> Option<String>
fn docs() -> Option<String>
JSDoc/Flow comment to describe this type – when
Flow is derived, docs are
automatically read from your doc comments or #[doc = ".."] attributes.Source§fn decl(cfg: &Config) -> String
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. Read moreSource§fn decl_concrete(cfg: &Config) -> String
fn decl_concrete(cfg: &Config) -> String
Declaration of this type using the supplied generic arguments.
The resulting Flow definition will not be generic. For that, see
Flow::decl().
If this type is not generic, then this function is equivalent to Flow::decl().Source§fn inline_flattened(cfg: &Config) -> String
fn inline_flattened(cfg: &Config) -> String
Flatten a type declaration.
This function will panic if the type cannot be flattened.
Source§fn visit_dependencies(_: &mut impl TypeVisitor)where
Self: 'static,
fn visit_dependencies(_: &mut impl TypeVisitor)where
Self: 'static,
Iterate over all dependencies of this type.
Source§fn visit_generics(_: &mut impl TypeVisitor)where
Self: 'static,
fn visit_generics(_: &mut impl TypeVisitor)where
Self: 'static,
Iterate over all type parameters of this type.
Source§fn dependencies(cfg: &Config) -> Vec<Dependency>where
Self: 'static,
fn dependencies(cfg: &Config) -> Vec<Dependency>where
Self: 'static,
Resolve all dependencies of this type recursively.
Source§fn output_path() -> Option<PathBuf>
fn output_path() -> Option<PathBuf>
Output file path relative to the export directory.
Source§fn export(cfg: &Config) -> Result<(), ExportError>where
Self: 'static,
fn export(cfg: &Config) -> Result<(), ExportError>where
Self: 'static,
Export this type to disk.
Source§fn export_all(cfg: &Config) -> Result<(), ExportError>where
Self: 'static,
fn export_all(cfg: &Config) -> Result<(), ExportError>where
Self: 'static,
Export this type to disk, together with all of its dependencies.
Source§fn export_to_string(cfg: &Config) -> Result<String, ExportError>where
Self: 'static,
fn export_to_string(cfg: &Config) -> Result<String, ExportError>where
Self: 'static,
Render this type as a string, returning the full file content.
Auto Trait Implementations§
impl Freeze for Dummy
impl RefUnwindSafe for Dummy
impl Send for Dummy
impl Sync for Dummy
impl Unpin for Dummy
impl UnsafeUnpin for Dummy
impl UnwindSafe for Dummy
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more