Struct oxide_api::types::Route

pub struct Route {
    pub description: String,
    pub destination: RouteDestination,
    pub id: String,
    pub kind: RouteKind,
    pub name: String,
    pub router_id: String,
    pub target: RouteTarget,
    pub time_created: Option<DateTime<Utc>>,
    pub time_modified: Option<DateTime<Utc>>,
}

A route defines a rule that governs where traffic should be sent based on its destination.

Fields

description: String

human-readable free-form text about a resource

destination: RouteDestination

id: String

human-readable free-form text about a resource

kind: RouteKind

The classification of a [RouterRoute] as defined by the system. The kind determines certain attributes such as if the route is modifiable and describes how or where the route was created.

See RFD-21 for more context

name: String

human-readable free-form text about a resource

router_id: String

human-readable free-form text about a resource

target: RouteTarget

time_created: Option<DateTime<Utc>>

timestamp when this resource was created

time_modified: Option<DateTime<Utc>>

timestamp when this resource was created

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Route

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Route

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &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<Route> for Route

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

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

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

This method tests for !=.

impl Serialize for Route

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 Route