Struct pschema_rs::shape::shex::ShapeReference

pub struct ShapeReference { /* private fields */ }

The ShapeReference struct contains a label, property ID, and a reference to a Shape object.

Properties:

• label: The label is a u8 (unsigned 8-bit integer) that represents a unique identifier for the ShapeReference object.
• property_id: property_id is a u32 (unsigned 32-bit integer) that represents the unique identifier of a property associated with the ShapeReference. This identifier can be used to retrieve additional information about the property from a database or other data source.
• reference: reference is a field of type Shape that is contained within the ShapeReference struct. It is likely a reference to another instance of the Shape struct.

Implementations

impl ShapeReference

The above code is implementing a method for a struct called ShapeReference. The new method takes in a label of type u8, a property_id of type u32, and a dst of type Shape, and returns a new instance of ShapeReference with those values. The get_reference method takes in self and returns the reference field of the ShapeReference instance.

pub fn new(label: u8, property_id: u32, dst: Shape) -> Self

This is a constructor function that creates a new instance of a struct with a label, property ID, and reference to a shape.

Arguments:

• label: The label is a u8 value that represents the type of the property. For example, a label of 0 could represent a string property, while a label of 1 could represent a numeric property.
• property_id: The property_id parameter is a 32-bit unsigned integer that represents the ID of a property associated with a shape. It is used as a unique identifier for the property.
• dst: dst is a parameter of type Shape which represents the destination shape of a relationship. It is used in the context of creating a new relationship instance with the given label, property_id, and dst.

Returns:

The new function is returning an instance of the Self struct, which contains the label, property_id, and reference fields.

pub fn get_reference(self) -> Shape

This Rust function returns a Shape reference.

Returns:

A Shape object is being returned.

Trait Implementations

impl Clone for ShapeReference

fn clone(&self) -> ShapeReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeReference

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

Formats the value using the given formatter.

impl From<ShapeReference> for Shape

The above code is implementing the From trait for the ShapeReference struct, which allows creating a Shape enum variant ShapeReference from a ShapeReference struct. The ShapeReference struct is wrapped in a Box and then converted to the Shape enum variant ShapeReference.

fn from(value: ShapeReference) -> Self

Converts to this type from the input type.

impl PartialEq<ShapeReference> for ShapeReference

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ShapeReference