Struct TypeAnnotation 

pub struct TypeAnnotation {
    pub name: String,
    pub major_version: u32,
    pub minor_version: u32,
}

A type annotation from CollecTor descriptor archives.

CollecTor archives include a type annotation on the first line of each descriptor file in the format @type <name> <major>.<minor>. This struct represents that parsed annotation.

Format

@type server-descriptor 1.0
@type network-status-consensus-3 1.0
@type microdescriptor 1.0

Example

use stem_rs::descriptor::TypeAnnotation;

let annotation = TypeAnnotation::parse("@type server-descriptor 1.0").unwrap();
assert_eq!(annotation.name, "server-descriptor");
assert_eq!(annotation.major_version, 1);
assert_eq!(annotation.minor_version, 0);

// Convert back to string
assert_eq!(annotation.to_string(), "@type server-descriptor 1.0");

See Also

• DescriptorType - Enum of known descriptor types
• strip_type_annotation - Extract annotation from content

Fields

name: String

The descriptor type name (e.g., “server-descriptor”, “microdescriptor”).

major_version: u32

The major version number.

minor_version: u32

The minor version number.

Implementations

impl TypeAnnotation

pub fn new( name: impl Into<String>, major_version: u32, minor_version: u32, ) -> Self

Creates a new type annotation with the given name and version.

Arguments

• name - The descriptor type name
• major_version - The major version number
• minor_version - The minor version number

Example

use stem_rs::descriptor::TypeAnnotation;

let annotation = TypeAnnotation::new("server-descriptor", 1, 0);
assert_eq!(annotation.to_string(), "@type server-descriptor 1.0");

pub fn parse(line: &str) -> Option<Self>

Parses a type annotation from a line of text.

Returns None if the line is not a valid type annotation.

Arguments

• line - The line to parse

Example

use stem_rs::descriptor::TypeAnnotation;

// Valid annotation
let annotation = TypeAnnotation::parse("@type extra-info 1.0").unwrap();
assert_eq!(annotation.name, "extra-info");

// Invalid - not an annotation
assert!(TypeAnnotation::parse("router test 127.0.0.1").is_none());

// Invalid - missing version
assert!(TypeAnnotation::parse("@type server-descriptor").is_none());

Trait Implementations

impl Clone for TypeAnnotation

fn clone(&self) -> TypeAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeAnnotation

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

Formats the value using the given formatter.

impl Display for TypeAnnotation

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

Formats the value using the given formatter.

impl PartialEq for TypeAnnotation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TypeAnnotation

impl StructuralPartialEq for TypeAnnotation