Struct chirpstack_api::fuota::Deployment

pub struct Deployment {

    pub application_id: i64,
    pub devices: Vec<DeploymentDevice>,
    pub multicast_group_type: i32,
    pub multicast_dr: u32,
    pub multicast_ping_slot_period: u32,
    pub multicast_frequency: u32,
    pub multicast_group_id: u32,
    pub multicast_timeout: u32,
    pub unicast_timeout: Option<Duration>,
    pub unicast_attempt_count: u32,
    pub fragmentation_fragment_size: u32,
    pub payload: Vec<u8>,
    pub fragmentation_redundancy: u32,
    pub fragmentation_session_index: u32,
    pub fragmentation_matrix: u32,
    pub fragmentation_block_ack_delay: u32,
    pub fragmentation_descriptor: Vec<u8>,
    pub request_fragmentation_session_status: i32,
}

Fields

application_id: i64

Application ID.

devices: Vec<DeploymentDevice>

Devices to include in this deployment.

multicast_group_type: i32

Multicast-group type.

multicast_dr: u32

Multicast data-rate.

multicast_ping_slot_period: u32

Multicast ping-slot period (Class-B only).

multicast_frequency: u32

Multicast frequency (Hz).

multicast_group_id: u32

Multicast group ID.

multicast_timeout: u32

Multicast timeout. This defines the timeout of the multicast-session. Please refer to the Remote Multicast Setup specification as this field has a different meaning for Class-B and Class-C groups.

unicast_timeout: Option<Duration>

Unicast timeout. Set this to the value in which you at least expect an uplink frame from the device. The FUOTA server will wait for the given time before attempting a retry or continuing with the next step.

unicast_attempt_count: u32

Unicast attempt count. The number of attempts before considering an unicast command to be failed.

fragmentation_fragment_size: u32

FragmentationFragmentSize. This defines the size of each payload fragment. Please refer to the Regional Parameters specification for the maximum payload sizes per data-rate and region.

payload: Vec<u8>

Payload.

fragmentation_redundancy: u32

Fragmentation redundancy. The number represents the additional redundant frames to send.

fragmentation_session_index: u32

Fragmentation session index.

fragmentation_matrix: u32

Fragmentation matrix.

fragmentation_block_ack_delay: u32

Block ack delay.

fragmentation_descriptor: Vec<u8>

Descriptor (4 bytes).

request_fragmentation_session_status: i32

Request fragmentation session status.

Implementations

impl Deployment

pub fn multicast_group_type(&self) -> MulticastGroupType

Returns the enum value of multicast_group_type, or the default if the field is set to an invalid enum value.

pub fn set_multicast_group_type(&mut self, value: MulticastGroupType)

Sets multicast_group_type to the provided enum value.

pub fn request_fragmentation_session_status(
    &self
) -> RequestFragmentationSessionStatus

Returns the enum value of request_fragmentation_session_status, or the default if the field is set to an invalid enum value.

pub fn set_request_fragmentation_session_status(
    &mut self,
    value: RequestFragmentationSessionStatus
)

Sets request_fragmentation_session_status to the provided enum value.

Trait Implementations

impl Clone for Deployment

fn clone(&self) -> Deployment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Deployment

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

Formats the value using the given formatter.

impl Default for Deployment

fn default() -> Self

Returns the “default value” for a type.

impl Message for Deployment

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Deployment> for Deployment

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

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

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

This method tests for !=.

impl StructuralPartialEq for Deployment