Enum DimName 

#[repr(u32)]
pub enum DimName {
    Batch = 0,
    Height = 1,
    Width = 2,
    NumClasses = 3,
    NumFeatures = 4,
    NumBoxes = 5,
    NumProtos = 6,
    NumAnchorsXFeatures = 7,
    Padding = 8,
    BoxCoords = 9,
    NumQueries = 11,
    Unknown = 10,
}

A named tensor axis. The code is the one the C EF_DIM_NAME_* enumerators and the Python DimName enum use.

Variants

Batch = 0

Height = 1

Width = 2

NumClasses = 3

NumFeatures = 4

NumBoxes = 5

NumProtos = 6

NumAnchorsXFeatures = 7

Padding = 8

BoxCoords = 9

NumQueries = 11

Query axis of mask-classification outputs (class_logits, mask_logits).

Unknown = 10

Any axis name the HAL does not recognise (e.g. a producer’s channels on the input dshape). Preserved so the dshape length still matches the shape and the axis sorts to the canonical tail in swap_axes_if_needed, but it never satisfies a required-dimension check. Keeps metadata parsing tolerant of unknown axis names instead of failing the whole decoder build.

Implementations

impl DimName

pub const fn code(self) -> u32

The shared code for this variant. Identical on every surface.

const, deliberately: a downstream binding that cannot write Variant = OtherEnum::Variant.code() in a #[pyclass] discriminant position (PyO3 requires a literal there) can still pin that literal to this value with a const _: () = assert!(...) – a build-time check instead of a hand-synced comment. See PyTensorMemory/PyPixelFormat in crates/python-common/src/tensor.rs for the consumer.

pub fn from_code(code: u32) -> Option<Self>

Reject an unknown code rather than guessing at one.

pub fn as_str(self) -> &'static str

The wire string form – stable, unlike Debug.

pub fn from_str_code(s: &str) -> Option<Self>

Reject an unknown string rather than guessing at one.

pub fn all() -> &'static [Self]

Every variant, for exhaustive cross-surface tests.

Trait Implementations

impl Clone for DimName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DimName

impl Debug for DimName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DimName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DimName

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

Formats the DimName for display

Examples

let dim = DimName::Height;
assert_eq!(format!("{}", dim), "height");

impl Eq for DimName

impl Hash for DimName

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

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 PartialEq for DimName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DimName

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 DimName