pub enum FileExportFormat {
Fbx,
Glb,
Gltf,
Obj,
Ply,
Step,
Stl,
}
Expand description
The valid types of output file formats.
Variants§
Fbx
Autodesk Filmbox (FBX) format. https://en.wikipedia.org/wiki/FBX
Glb
Binary glTF 2.0.
This is a single binary with .glb extension.
This is better if you want a compressed format as opposed to the human readable glTF that lacks compression.
Gltf
glTF 2.0. Embedded glTF 2.0 (pretty printed).
Single JSON file with .gltf extension binary data encoded as base64 data URIs.
The JSON contents are pretty printed.
It is human readable, single file, and you can view the diff easily in a git commit.
Obj
The OBJ file format. https://en.wikipedia.org/wiki/Wavefront_.obj_file It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
Ply
The PLY file format. https://en.wikipedia.org/wiki/PLY_(file_format)
Step
The STEP file format. https://en.wikipedia.org/wiki/ISO_10303-21
Stl
The STL file format. https://en.wikipedia.org/wiki/STL_(file_format)
Trait Implementations§
Source§impl Clone for FileExportFormat
impl Clone for FileExportFormat
Source§fn clone(&self) -> FileExportFormat
fn clone(&self) -> FileExportFormat
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FileExportFormat
impl Debug for FileExportFormat
Source§impl<'de> Deserialize<'de> for FileExportFormat
impl<'de> Deserialize<'de> for FileExportFormat
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Display for FileExportFormat
impl Display for FileExportFormat
Source§impl ExternType for FileExportFormat
impl ExternType for FileExportFormat
Source§impl From<FileExportFormat> for FileExportFormat
impl From<FileExportFormat> for FileExportFormat
Source§fn from(format: FileExportFormat) -> FileExportFormat
fn from(format: FileExportFormat) -> FileExportFormat
Source§impl From<FileExportFormat> for OutputFormat3d
impl From<FileExportFormat> for OutputFormat3d
Source§fn from(export_format: FileExportFormat) -> Self
fn from(export_format: FileExportFormat) -> Self
Source§impl From<OutputFormat3d> for FileExportFormat
impl From<OutputFormat3d> for FileExportFormat
Source§fn from(output_format: OutputFormat3d) -> Self
fn from(output_format: OutputFormat3d) -> Self
Source§impl FromStr for FileExportFormat
impl FromStr for FileExportFormat
Source§impl<'py> IntoPyObject<'py> for FileExportFormat
impl<'py> IntoPyObject<'py> for FileExportFormat
Source§type Target = FileExportFormat
type Target = FileExportFormat
Source§type Output = Bound<'py, <FileExportFormat as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <FileExportFormat as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl JsonSchema for FileExportFormat
impl JsonSchema for FileExportFormat
Source§fn schema_name() -> String
fn schema_name() -> String
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
$ref
keyword. Read moreSource§impl Ord for FileExportFormat
impl Ord for FileExportFormat
Source§fn cmp(&self, other: &FileExportFormat) -> Ordering
fn cmp(&self, other: &FileExportFormat) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for FileExportFormat
impl PartialEq for FileExportFormat
Source§impl PartialOrd for FileExportFormat
impl PartialOrd for FileExportFormat
Source§impl PyClass for FileExportFormat
impl PyClass for FileExportFormat
Source§impl PyClassImpl for FileExportFormat
impl PyClassImpl for FileExportFormat
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§type ThreadChecker = SendablePyClass<FileExportFormat>
type ThreadChecker = SendablePyClass<FileExportFormat>
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
PyAny
by default, and when you declare
#[pyclass(extends=PyDict)]
, it’s PyDict
.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
fn dict_offset() -> Option<isize>
fn weaklist_offset() -> Option<isize>
Source§impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a FileExportFormat
impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a FileExportFormat
Source§impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut FileExportFormat
impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut FileExportFormat
Source§impl PyStubType for FileExportFormat
impl PyStubType for FileExportFormat
Source§fn type_output() -> TypeInfo
fn type_output() -> TypeInfo
Source§fn type_input() -> TypeInfo
fn type_input() -> TypeInfo
Source§impl PyTypeInfo for FileExportFormat
impl PyTypeInfo for FileExportFormat
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Source§impl Sequence for FileExportFormat
impl Sequence for FileExportFormat
Source§impl Serialize for FileExportFormat
impl Serialize for FileExportFormat
Source§impl TS for FileExportFormat
impl TS for FileExportFormat
Source§type WithoutGenerics = FileExportFormat
type WithoutGenerics = FileExportFormat
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
. Read moreSource§type OptionInnerType = FileExportFormat
type OptionInnerType = FileExportFormat
std::option::Option<T>
, then this associated type is set to T
.
All other implementations of TS
should set this type to Self
instead.Source§fn docs() -> Option<String>
fn docs() -> Option<String>
TS
is derived, docs are
automatically read from your doc comments or #[doc = ".."]
attributesSource§fn decl_concrete() -> String
fn decl_concrete() -> String
TS::decl()
.
If this type is not generic, then this function is equivalent to TS::decl()
.Source§fn decl() -> String
fn decl() -> String
type User = { user_id: number, ... }
.
This function will panic if the type has no declaration. Read moreSource§fn inline() -> String
fn inline() -> String
{ user_id: number }
.
This function will panic if the type cannot be inlined.Source§fn inline_flattened() -> String
fn inline_flattened() -> String
This function will panic if the type cannot be flattened.
Source§fn visit_generics(v: &mut impl TypeVisitor)where
Self: 'static,
fn visit_generics(v: &mut impl TypeVisitor)where
Self: 'static,
Source§fn output_path() -> Option<PathBuf>
fn output_path() -> Option<PathBuf>
T
should be exported.The returned path does not include the base directory from
TS_RS_EXPORT_DIR
. Read moreSource§fn visit_dependencies(v: &mut impl TypeVisitor)where
Self: 'static,
fn visit_dependencies(v: &mut impl TypeVisitor)where
Self: 'static,
Source§fn dependencies() -> Vec<Dependency>where
Self: 'static,
fn dependencies() -> Vec<Dependency>where
Self: 'static,
Source§fn export() -> Result<(), ExportError>where
Self: 'static,
fn export() -> Result<(), ExportError>where
Self: 'static,
TS::export_all
. Read moreSource§fn export_all() -> Result<(), ExportError>where
Self: 'static,
fn export_all() -> Result<(), ExportError>where
Self: 'static,
To export only this type, without its dependencies, use
TS::export
. Read moreSource§fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>where
Self: 'static,
fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>where
Self: 'static,
To export only this type, without its dependencies, use
TS::export
. Read moreSource§fn export_to_string() -> Result<String, ExportError>where
Self: 'static,
fn export_to_string() -> Result<String, ExportError>where
Self: 'static,
impl Copy for FileExportFormat
impl Eq for FileExportFormat
impl StructuralPartialEq for FileExportFormat
Auto Trait Implementations§
impl Freeze for FileExportFormat
impl RefUnwindSafe for FileExportFormat
impl Send for FileExportFormat
impl Sync for FileExportFormat
impl Unpin for FileExportFormat
impl UnwindSafe for FileExportFormat
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<T> FromPyObject<'_> for T
impl<T> FromPyObject<'_> for T
Source§impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self
into an owned Python object, dropping type information.