Struct Path 

pub struct Path {

    pub id: ArtifactId,
    pub sub_type: PathSubType,
    pub plane_id: ArtifactId,
    pub seg_ids: Vec<ArtifactId>,
    pub consumed: bool,
    pub sweep_id: Option<ArtifactId>,
    pub trajectory_sweep_id: Option<ArtifactId>,
    pub solid2d_id: Option<ArtifactId>,
    pub code_ref: CodeRef,
    pub composite_solid_id: Option<ArtifactId>,
    pub sketch_block_id: Option<ArtifactId>,
    pub origin_path_id: Option<ArtifactId>,
    pub inner_path_id: Option<ArtifactId>,
    pub outer_path_id: Option<ArtifactId>,
    pub pattern_ids: Vec<ArtifactId>,
}

Fields

id: ArtifactId

sub_type: PathSubType

plane_id: ArtifactId

seg_ids: Vec<ArtifactId>

consumed: bool

Whether this artifact has been used in a subsequent operation

sweep_id: Option<ArtifactId>

The sweep, if any, that this Path serves as the base path for. corresponds to path_id on the Sweep.

trajectory_sweep_id: Option<ArtifactId>

The sweep, if any, that this Path serves as the trajectory for.

solid2d_id: Option<ArtifactId>

code_ref: CodeRef

composite_solid_id: Option<ArtifactId>

This is the ID of the composite solid that this is part of, if any, as this can be used as input for another composite solid.

sketch_block_id: Option<ArtifactId>

For sketch paths, the ID of the sketch block this path was created from. None for region paths and paths created in other ways.

origin_path_id: Option<ArtifactId>

For region paths, the ID of the sketch path this region was created from. None for sketch paths.

inner_path_id: Option<ArtifactId>

The hole, if any, from a subtract2d() call.

outer_path_id: Option<ArtifactId>

The Path that this is a hole of, if any. The inverse link of inner_path_id.

pattern_ids: Vec<ArtifactId>

Pattern operations that use this path as their source.

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Path

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Path

fn schema_name() -> String

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Path

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Path

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Path

impl TS for Path

type WithoutGenerics = Path

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 = Path

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 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 Self: '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 Self: 'static,

Iterates over all dependency of this type.

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 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.