Struct sync_manager::msg_types::SyncParams

pub struct SyncParams {
    pub engines_to_sync: Vec<String>,
    pub sync_all_engines: bool,
    pub reason: i32,
    pub engines_to_change_state: HashMap<String, bool>,
    pub persisted_state: Option<String>,
    pub acct_key_id: String,
    pub acct_access_token: String,
    pub acct_tokenserver_url: String,
    pub acct_sync_key: String,
    pub fxa_device_id: String,
    pub device_name: String,
    pub device_type: i32,
}

Fields

engines_to_sync: Vec<String>

sync_all_engines: bool

reason: i32

engines_to_change_state: HashMap<String, bool>

persisted_state: Option<String>

acct_key_id: String

These conceptually are a nested type, but exposing them as such would add needless complexity to the FFI.

acct_access_token: String

acct_tokenserver_url: String

acct_sync_key: String

fxa_device_id: String

device_name: String

device_type: i32

Implementations

impl SyncParams

pub fn reason(&self) -> SyncReason

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

pub fn set_reason(&mut self, value: SyncReason)

Sets reason to the provided enum value.

pub fn persisted_state(&self) -> &str

Returns the value of persisted_state, or the default value if persisted_state is unset.

pub fn device_type(&self) -> DeviceType

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

pub fn set_device_type(&mut self, value: DeviceType)

Sets device_type to the provided enum value.

Trait Implementations

impl Clone for SyncParams

fn clone(&self) -> SyncParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncParams

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

Formats the value using the given formatter.

impl Default for SyncParams

fn default() -> SyncParams

Returns the "default value" for a type.

impl IntoFfi for SyncParams where
    SyncParams: Message, 

type Value = ByteBuffer

This type must be:

fn ffi_default() -> Self::Value

Return an 'empty' value. This is what's passed back to C in the case of an error, so it doesn't actually need to be "empty", so much as "ignorable". Note that this is also used when an empty Option<T> is returned.

fn into_ffi_value(self) -> Self::Value

Convert ourselves into a value we can pass back to C with confidence.

impl Message for SyncParams

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_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

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

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

Decodes an instance of the message from a buffer.

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

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<SyncParams> for SyncParams

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

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

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

This method tests for !=.

impl StructuralPartialEq for SyncParams