Struct xplm::data::borrowed::DataRef

pub struct DataRef<T: ?Sized, A = ReadOnly> { /* private fields */ }

A dataref created by X-Plane or another plugin

T is the data type stored in the dataref.

A is the access level (ReadOnly or ReadWrite)

Implementations

impl<T: DataType + ?Sized> DataRef<T, ReadOnly>

pub fn find(name: &str) -> Result<Self, FindError>

Finds a readable dataref by its name

Returns an error if the dataref does not exist or has the wrong type

Examples found in repository

examples/dataref.rs (line 42)

    fn start() -> Result<Self, Self::Error> {
        let plugin = DataRefPlugin {
            has_joystick: DataRef::find("sim/joystick/has_joystick")?,
            earth_mu: DataRef::find("sim/physics/earth_mu")?,
            date: DataRef::find("sim/time/local_date_days")?.writeable()?,
            sim_build_string: DataRef::find("sim/version/sim_build_string")?,
            latitude: DataRef::find("sim/flightmodel/position/latitude")?,
            joystick_axis_values: DataRef::find("sim/joystick/joystick_axis_values")?,
            battery_on: DataRef::find("sim/cockpit2/electrical/battery_on")?.writeable()?,
        };
        Ok(plugin)
    }

pub fn writeable(self) -> Result<DataRef<T, ReadWrite>, FindError>

Makes this dataref writable

Returns an error if the dataref cannot be written.

Examples found in repository

examples/dataref.rs (line 44)

    fn start() -> Result<Self, Self::Error> {
        let plugin = DataRefPlugin {
            has_joystick: DataRef::find("sim/joystick/has_joystick")?,
            earth_mu: DataRef::find("sim/physics/earth_mu")?,
            date: DataRef::find("sim/time/local_date_days")?.writeable()?,
            sim_build_string: DataRef::find("sim/version/sim_build_string")?,
            latitude: DataRef::find("sim/flightmodel/position/latitude")?,
            joystick_axis_values: DataRef::find("sim/joystick/joystick_axis_values")?,
            battery_on: DataRef::find("sim/cockpit2/electrical/battery_on")?.writeable()?,
        };
        Ok(plugin)
    }

Trait Implementations

impl<A> ArrayRead<[f32]> for DataRef<[f32], A>

fn get(&self, dest: &mut [f32]) -> usize

Reads values

fn len(&self) -> usize

Returns the length of the data array

fn as_vec(&self) -> Vec<T::Element>

where T::Element: Default + Clone,

Returns all values in this accessor as a Vec

impl<A> ArrayRead<[i32]> for DataRef<[i32], A>

fn get(&self, dest: &mut [i32]) -> usize

Reads values

fn len(&self) -> usize

Returns the length of the data array

fn as_vec(&self) -> Vec<T::Element>

where T::Element: Default + Clone,

Returns all values in this accessor as a Vec

impl<A> ArrayRead<[i8]> for DataRef<[i8], A>

fn get(&self, dest: &mut [i8]) -> usize

Reads values

fn len(&self) -> usize

Returns the length of the data array

fn as_vec(&self) -> Vec<T::Element>

where T::Element: Default + Clone,

Returns all values in this accessor as a Vec

impl<A> ArrayRead<[u32]> for DataRef<[u32], A>

fn get(&self, dest: &mut [u32]) -> usize

Reads values

fn len(&self) -> usize

Returns the length of the data array

fn as_vec(&self) -> Vec<T::Element>

where T::Element: Default + Clone,

Returns all values in this accessor as a Vec

impl<A> ArrayRead<[u8]> for DataRef<[u8], A>

fn get(&self, dest: &mut [u8]) -> usize

Reads values

fn len(&self) -> usize

Returns the length of the data array

fn as_vec(&self) -> Vec<T::Element>

where T::Element: Default + Clone,

Returns all values in this accessor as a Vec

impl ArrayReadWrite<[f32]> for DataRef<[f32], ReadWrite>

fn set(&mut self, values: &[f32])

Writes values

impl ArrayReadWrite<[i32]> for DataRef<[i32], ReadWrite>

fn set(&mut self, values: &[i32])

Writes values

impl ArrayReadWrite<[i8]> for DataRef<[i8], ReadWrite>

fn set(&mut self, values: &[i8])

Writes values

impl ArrayReadWrite<[u32]> for DataRef<[u32], ReadWrite>

fn set(&mut self, values: &[u32])

Writes values

impl ArrayReadWrite<[u8]> for DataRef<[u8], ReadWrite>

fn set(&mut self, values: &[u8])

Writes values

impl<A> DataRead<bool> for DataRef<bool, A>

fn get(&self) -> bool

Reads a value

impl<A> DataRead<f32> for DataRef<f32, A>

fn get(&self) -> f32

Reads a value

impl<A> DataRead<f64> for DataRef<f64, A>

fn get(&self) -> f64

Reads a value

impl<A> DataRead<i16> for DataRef<i16, A>

fn get(&self) -> i16

Reads a value

impl<A> DataRead<i32> for DataRef<i32, A>

fn get(&self) -> i32

Reads a value

impl<A> DataRead<i8> for DataRef<i8, A>

fn get(&self) -> i8

Reads a value

impl<A> DataRead<u16> for DataRef<u16, A>

fn get(&self) -> u16

Reads a value

impl<A> DataRead<u32> for DataRef<u32, A>

fn get(&self) -> u32

Reads a value

impl<A> DataRead<u8> for DataRef<u8, A>

fn get(&self) -> u8

Reads a value

impl DataReadWrite<bool> for DataRef<bool, ReadWrite>

fn set(&mut self, value: bool)

Writes a value

impl DataReadWrite<f32> for DataRef<f32, ReadWrite>

fn set(&mut self, value: f32)

Writes a value

impl DataReadWrite<f64> for DataRef<f64, ReadWrite>

fn set(&mut self, value: f64)

Writes a value

impl DataReadWrite<i16> for DataRef<i16, ReadWrite>

fn set(&mut self, value: i16)

Writes a value

impl DataReadWrite<i32> for DataRef<i32, ReadWrite>

fn set(&mut self, value: i32)

Writes a value

impl DataReadWrite<i8> for DataRef<i8, ReadWrite>

fn set(&mut self, value: i8)

Writes a value

impl DataReadWrite<u16> for DataRef<u16, ReadWrite>

fn set(&mut self, value: u16)

Writes a value

impl DataReadWrite<u32> for DataRef<u32, ReadWrite>

fn set(&mut self, value: u32)

Writes a value

impl DataReadWrite<u8> for DataRef<u8, ReadWrite>

fn set(&mut self, value: u8)

Writes a value