Struct rust_sc2::Request[][src]

pub struct Request {
    pub id: Option<u32>,
    pub request: Option<Request_oneof_request>,
    pub unknown_fields: UnknownFields,
    pub cached_size: CachedSize,
}
Expand description

Request to the SC2 API.

Usage

let mut request = Request::new();

/* modify request through it's methods */

let response = self.api().send(request)?;

Generated files are compatible only with the same version of protobuf runtime.

Fields

id: Option<u32>request: Option<Request_oneof_request>unknown_fields: UnknownFieldscached_size: CachedSize

Implementations

impl Request[src]

Request to the SC2 API.

Usage

let mut request = Request::new();

/* modify request through it's methods */

let response = self.api().send(request)?;

pub fn new() -> Request[src]

pub fn get_create_game(&self) -> &RequestCreateGame[src]

pub fn clear_create_game(&mut self)[src]

pub fn has_create_game(&self) -> bool[src]

pub fn set_create_game(&mut self, v: RequestCreateGame)[src]

pub fn mut_create_game(&mut self) -> &mut RequestCreateGame[src]

pub fn take_create_game(&mut self) -> RequestCreateGame[src]

pub fn get_join_game(&self) -> &RequestJoinGame[src]

pub fn clear_join_game(&mut self)[src]

pub fn has_join_game(&self) -> bool[src]

pub fn set_join_game(&mut self, v: RequestJoinGame)[src]

pub fn mut_join_game(&mut self) -> &mut RequestJoinGame[src]

pub fn take_join_game(&mut self) -> RequestJoinGame[src]

pub fn get_restart_game(&self) -> &RequestRestartGame[src]

pub fn clear_restart_game(&mut self)[src]

pub fn has_restart_game(&self) -> bool[src]

pub fn set_restart_game(&mut self, v: RequestRestartGame)[src]

pub fn mut_restart_game(&mut self) -> &mut RequestRestartGame[src]

pub fn take_restart_game(&mut self) -> RequestRestartGame[src]

pub fn get_start_replay(&self) -> &RequestStartReplay[src]

pub fn clear_start_replay(&mut self)[src]

pub fn has_start_replay(&self) -> bool[src]

pub fn set_start_replay(&mut self, v: RequestStartReplay)[src]

pub fn mut_start_replay(&mut self) -> &mut RequestStartReplay[src]

pub fn take_start_replay(&mut self) -> RequestStartReplay[src]

pub fn get_leave_game(&self) -> &RequestLeaveGame[src]

pub fn clear_leave_game(&mut self)[src]

pub fn has_leave_game(&self) -> bool[src]

pub fn set_leave_game(&mut self, v: RequestLeaveGame)[src]

pub fn mut_leave_game(&mut self) -> &mut RequestLeaveGame[src]

pub fn take_leave_game(&mut self) -> RequestLeaveGame[src]

pub fn get_quick_save(&self) -> &RequestQuickSave[src]

pub fn clear_quick_save(&mut self)[src]

pub fn has_quick_save(&self) -> bool[src]

pub fn set_quick_save(&mut self, v: RequestQuickSave)[src]

pub fn mut_quick_save(&mut self) -> &mut RequestQuickSave[src]

pub fn take_quick_save(&mut self) -> RequestQuickSave[src]

pub fn get_quick_load(&self) -> &RequestQuickLoad[src]

pub fn clear_quick_load(&mut self)[src]

pub fn has_quick_load(&self) -> bool[src]

pub fn set_quick_load(&mut self, v: RequestQuickLoad)[src]

pub fn mut_quick_load(&mut self) -> &mut RequestQuickLoad[src]

pub fn take_quick_load(&mut self) -> RequestQuickLoad[src]

pub fn get_quit(&self) -> &RequestQuit[src]

pub fn clear_quit(&mut self)[src]

pub fn has_quit(&self) -> bool[src]

pub fn set_quit(&mut self, v: RequestQuit)[src]

pub fn mut_quit(&mut self) -> &mut RequestQuit[src]

pub fn take_quit(&mut self) -> RequestQuit[src]

pub fn get_game_info(&self) -> &RequestGameInfo[src]

pub fn clear_game_info(&mut self)[src]

pub fn has_game_info(&self) -> bool[src]

pub fn set_game_info(&mut self, v: RequestGameInfo)[src]

pub fn mut_game_info(&mut self) -> &mut RequestGameInfo[src]

pub fn take_game_info(&mut self) -> RequestGameInfo[src]

pub fn get_observation(&self) -> &RequestObservation[src]

pub fn clear_observation(&mut self)[src]

pub fn has_observation(&self) -> bool[src]

pub fn set_observation(&mut self, v: RequestObservation)[src]

pub fn mut_observation(&mut self) -> &mut RequestObservation[src]

pub fn take_observation(&mut self) -> RequestObservation[src]

pub fn get_action(&self) -> &RequestAction[src]

pub fn clear_action(&mut self)[src]

pub fn has_action(&self) -> bool[src]

pub fn set_action(&mut self, v: RequestAction)[src]

pub fn mut_action(&mut self) -> &mut RequestAction[src]

pub fn take_action(&mut self) -> RequestAction[src]

pub fn get_obs_action(&self) -> &RequestObserverAction[src]

pub fn clear_obs_action(&mut self)[src]

pub fn has_obs_action(&self) -> bool[src]

pub fn set_obs_action(&mut self, v: RequestObserverAction)[src]

pub fn mut_obs_action(&mut self) -> &mut RequestObserverAction[src]

pub fn take_obs_action(&mut self) -> RequestObserverAction[src]

pub fn get_step(&self) -> &RequestStep[src]

pub fn clear_step(&mut self)[src]

pub fn has_step(&self) -> bool[src]

pub fn set_step(&mut self, v: RequestStep)[src]

pub fn mut_step(&mut self) -> &mut RequestStep[src]

pub fn take_step(&mut self) -> RequestStep[src]

pub fn get_data(&self) -> &RequestData[src]

pub fn clear_data(&mut self)[src]

pub fn has_data(&self) -> bool[src]

pub fn set_data(&mut self, v: RequestData)[src]

pub fn mut_data(&mut self) -> &mut RequestData[src]

pub fn take_data(&mut self) -> RequestData[src]

pub fn get_query(&self) -> &RequestQuery[src]

pub fn clear_query(&mut self)[src]

pub fn has_query(&self) -> bool[src]

pub fn set_query(&mut self, v: RequestQuery)[src]

pub fn mut_query(&mut self) -> &mut RequestQuery[src]

pub fn take_query(&mut self) -> RequestQuery[src]

pub fn get_save_replay(&self) -> &RequestSaveReplay[src]

pub fn clear_save_replay(&mut self)[src]

pub fn has_save_replay(&self) -> bool[src]

pub fn set_save_replay(&mut self, v: RequestSaveReplay)[src]

pub fn mut_save_replay(&mut self) -> &mut RequestSaveReplay[src]

pub fn take_save_replay(&mut self) -> RequestSaveReplay[src]

pub fn get_map_command(&self) -> &RequestMapCommand[src]

pub fn clear_map_command(&mut self)[src]

pub fn has_map_command(&self) -> bool[src]

pub fn set_map_command(&mut self, v: RequestMapCommand)[src]

pub fn mut_map_command(&mut self) -> &mut RequestMapCommand[src]

pub fn take_map_command(&mut self) -> RequestMapCommand[src]

pub fn get_replay_info(&self) -> &RequestReplayInfo[src]

pub fn clear_replay_info(&mut self)[src]

pub fn has_replay_info(&self) -> bool[src]

pub fn set_replay_info(&mut self, v: RequestReplayInfo)[src]

pub fn mut_replay_info(&mut self) -> &mut RequestReplayInfo[src]

pub fn take_replay_info(&mut self) -> RequestReplayInfo[src]

pub fn get_available_maps(&self) -> &RequestAvailableMaps[src]

pub fn clear_available_maps(&mut self)[src]

pub fn has_available_maps(&self) -> bool[src]

pub fn set_available_maps(&mut self, v: RequestAvailableMaps)[src]

pub fn mut_available_maps(&mut self) -> &mut RequestAvailableMaps[src]

pub fn take_available_maps(&mut self) -> RequestAvailableMaps[src]

pub fn get_save_map(&self) -> &RequestSaveMap[src]

pub fn clear_save_map(&mut self)[src]

pub fn has_save_map(&self) -> bool[src]

pub fn set_save_map(&mut self, v: RequestSaveMap)[src]

pub fn mut_save_map(&mut self) -> &mut RequestSaveMap[src]

pub fn take_save_map(&mut self) -> RequestSaveMap[src]

pub fn get_ping(&self) -> &RequestPing[src]

pub fn clear_ping(&mut self)[src]

pub fn has_ping(&self) -> bool[src]

pub fn set_ping(&mut self, v: RequestPing)[src]

pub fn mut_ping(&mut self) -> &mut RequestPing[src]

pub fn take_ping(&mut self) -> RequestPing[src]

pub fn get_debug(&self) -> &RequestDebug[src]

pub fn clear_debug(&mut self)[src]

pub fn has_debug(&self) -> bool[src]

pub fn set_debug(&mut self, v: RequestDebug)[src]

pub fn mut_debug(&mut self) -> &mut RequestDebug[src]

pub fn take_debug(&mut self) -> RequestDebug[src]

pub fn get_id(&self) -> u32[src]

pub fn clear_id(&mut self)[src]

pub fn has_id(&self) -> bool[src]

pub fn set_id(&mut self, v: u32)[src]

Trait Implementations

impl Clear for Request[src]

pub fn clear(&mut self)[src]

Clear this make, make it equivalent to newly created object.

impl Clone for Request[src]

pub fn clone(&self) -> Request[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Request[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl Default for Request[src]

pub fn default() -> Request[src]

Returns the “default value” for a type. Read more

impl<'a> Default for &'a Request[src]

pub fn default() -> &'a Request[src]

Returns the “default value” for a type. Read more

impl Message for Request[src]

pub fn is_initialized(&self) -> bool[src]

True iff all required fields are initialized. Always returns true for protobuf 3. Read more

pub fn merge_from(
    &mut self,
    is: &mut CodedInputStream<'_>
) -> Result<(), ProtobufError>
[src]

Update this message object with fields read from given stream.

pub fn compute_size(&self) -> u32[src]

Compute and cache size of this message and all nested messages

pub fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError>
[src]

Write message to the stream. Read more

pub fn get_cached_size(&self) -> u32[src]

Get size previously computed by compute_size.

pub fn get_unknown_fields(&self) -> &UnknownFields[src]

Get a reference to unknown fields.

pub fn mut_unknown_fields(&mut self) -> &mut UnknownFields[src]

Get a mutable reference to unknown fields.

pub fn as_any(&self) -> &(dyn Any + 'static)[src]

View self as Any.

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)[src]

View self as mutable Any.

pub fn into_any(self: Box<Request, Global>) -> Box<dyn Any + 'static, Global>[src]

Convert boxed self to boxed Any.

pub fn descriptor(&self) -> &'static MessageDescriptor[src]

Message descriptor for this message, used for reflection.

pub fn new() -> Request[src]

Create an empty message object. Read more

pub fn descriptor_static() -> &'static MessageDescriptor[src]

Get message descriptor for message type. Read more

pub fn default_instance() -> &'static Request[src]

Return a pointer to default immutable message with static lifetime. Read more

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, ProtobufError>[src]

Parse message from stream.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), ProtobufError>[src]

Write the message to the stream. Read more

fn write_length_delimited_to(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError>
[src]

Write the message to the stream prepending the message with message length encoded as varint. Read more

fn write_length_delimited_to_vec(
    &self,
    vec: &mut Vec<u8, Global>
) -> Result<(), ProtobufError>
[src]

Write the message to the vec, prepend the message with message length encoded as varint. Read more

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), ProtobufError>[src]

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, ProtobufError>[src]

Parse message from reader. Parse stops on EOF or when error encountered. Read more

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, ProtobufError>[src]

Parse message from byte array.

fn check_initialized(&self) -> Result<(), ProtobufError>[src]

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), ProtobufError>[src]

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8, Global>) -> Result<(), ProtobufError>[src]

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8, Global>, ProtobufError>[src]

Write the message to bytes vec.

fn write_length_delimited_to_writer(
    &self,
    w: &mut dyn Write
) -> Result<(), ProtobufError>
[src]

Write the message to the writer, prepend the message with message length encoded as varint. Read more

fn write_length_delimited_to_bytes(
    &self
) -> Result<Vec<u8, Global>, ProtobufError>
[src]

Write the message to the bytes vec, prepend the message with message length encoded as varint. Read more

fn type_id(&self) -> TypeId[src]

Get type id for downcasting.

impl PartialEq<Request> for Request[src]

pub fn eq(&self, other: &Request) -> bool[src]

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

pub fn ne(&self, other: &Request) -> bool[src]

This method tests for !=.

impl ProtobufValue for Request[src]

pub fn as_ref(&self) -> ReflectValueRef<'_>[src]

As ref

fn as_any(&self) -> &(dyn Any + 'static)[src]

Convert to Any

fn is_non_zero(&self) -> bool[src]

Is value non-zero?

fn as_ref_copy(&self) -> ReflectValueRef<'static>[src]

Return ProtobufValueRef if self is Copy. Read more

impl StructuralPartialEq for Request[src]

Auto Trait Implementations

impl RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl UnwindSafe for Request

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V