Crate nv_redfish_core 

Core Redfish foundation library used by code generated from the CSDL compiler.

Purpose

• Serve as a dependency for autogenerated Redfish types produced by the CSDL compiler.
• Provide semantic-unaware primitives that generated code relies on.
• Avoid any knowledge of specific Redfish services, schemas, or OEM semantics.

Scope (building blocks only)

• Identity and metadata: ODataId, ODataETag
• EDM value wrappers: EdmDateTimeOffset, EdmDuration
• Navigation properties: NavProperty<T>
• Generic operation traits: Creatable, Updatable, Deletable
• Entity contracts: EntityTypeRef, Expandable
• Action envelope: Action<T, R>
• Client abstraction: Bmc (transport-agnostic interface used by generated code)

Non-goals

• No service- or schema-specific models are defined here.
• No business logic or policy decisions are embedded here.
• No transport specification

How generated code uses these primitives

• Each generated entity struct implements EntityTypeRef.
• Navigation properties in generated code are wrapped in NavProperty<T>.
• Generated actions are represented as Action<T, R>.
• If the schema allows it, generated types implement Creatable, Updatable, and/or Deletable and route operations through a user-provided Bmc implementation.

Modules

action

Action-related types. Redfish Action primitives

bmc

BMC trait and credentials. Baseboard Management Controller (BMC) client abstraction

deserialize

Custom deserialization helpers.

dynamic_properties

Dynamic properties support.

edm_date_time_offset

Edm.DateTimeOffset type. Edm.DateTimeOffset primitive wrapper

edm_duration

Edm.Duration type. Edm.Duration primitive wrapper

edm_primitive_type

Edm.PrimitiveType type.

nav_property

Navigation property wrapper. Navigation property wrapper for generated types

odata

Type for @odata.id identifier. OData identifiers used by generated types

query

Support of redfish queries OData query parameter builders for Redfish API requests.

Structs

Action

Defines a deserializable Action. It is almost always a member of the Actions struct in different parts of the Redfish object tree.

AsyncTask

Outcome of a mutating Redfish operation that can complete asynchronously.

EdmDateTimeOffset

Type corresponding to Edm.DateTimeOffset.

EdmDuration

EdmDuration represented by Edm.EdmDuration type.

EdmGuid

A Universally Unique Identifier (UUID).

FilterQuery

Builder for Redfish $filter query parameters according to DSP0266 specification.

ODataETag

Type for @odata.etag identifier.

ODataId

Type for @odata.id identifier.

Reference

Reference variant of the navigation property (only @odata.id property is specified).

ReferenceLeaf

ReferenceLeaf is special type that is used for navigation properties that if corresponding EntityType was not compiled to the tree.

Enums

AdditionalProperties

Represents any valid JSON value.

EdmPrimitiveType

Represents Edm.PrimitiveType

ModificationResponse

Outcome of a mutating Redfish operation.

NavProperty

Navigation property variants. All navigation properties in generated code are wrapped with this type.

Traits

ActionError

Action error trait. Needed in generated code when an action function is called for an action that wasn’t specified by the server.

Bmc

BMC trait defines access to a Baseboard Management Controller using the Redfish protocol.

Creatable

This trait is assigned to the collections that are marked as creatable in the CSDL specification.

Deletable

This trait is assigned to entity types that are marked as deletable in the CSDL specification.

EntityTypeRef

Entity type reference trait implemented by the CSDL compiler for all generated entity types and for all NavProperty<T> where T is a struct for an entity type.

Expandable

Defines entity types that support $expand via query parameters.

FilterProperty

Trait for types that can be used as filter properties in OData queries

RedfishSettings

This trait is assigned to updatable entity types to support @Redfish.Settings workflow.

ToFilterLiteral

Trait for types that can be converted to filter literals

ToSnakeCase

Trait for converting enum variants to snake_case strings

Updatable

This trait is assigned to entity types that are marked as updatable in the CSDL specification.

Functions

de_optional_nullable

Deserialize an optional nullable field. nv-redfish models these fields with Option<Option<T>>, where None means “no field” and Some(None) means the field is explicitly set to null.

de_required_nullable

Deserialize a required nullable field. nv-redfish models these fields with Option<T>, where None means null.

Type Aliases

BoxTryStream

Boxed fallible stream used by BMC streaming APIs.

DynamicProperties

Represents dynamic properties that can be assigned to Complex Type in CSDL.