Struct UeConf 

pub struct UeConf<'a> {
    pub action: Actions,
    pub path: &'a str,
    pub identifier: &'a str,
    pub x: u16,
    pub y: u16,
    pub width: Option<u16>,
    pub height: Option<u16>,
    pub scaler: Option<Scalers>,
    pub draw: Option<bool>,
    pub synchronously_draw: Option<bool>,
    pub scaling_position_x: Option<f32>,
    pub scaling_position_y: Option<f32>,
}

The configuration struct for the image drawing.

identifier and path are the only required fields and will throw a panic if left empty.

By default x and y will be set to 0 and all other option will be set to None

Example

use ueberzug::UeConf;
// The minimum required for proper config struct.
let conf = UeConf{
            identifier:"carb",
            path:"ferris.png",
            ..Default::default()
            };

// More specific option with starting x and y cordinates with width and height
let conf = UeConf{
            identifier:"crab",
            path:"ferris.png",
            x:20,
            y:5,
            width:Some(30),
            height:Some(30),
            ..Default::default()
            };

Fields

action: Actions

path: &'a str

identifier: &'a str

x: u16

y: u16

width: Option<u16>

height: Option<u16>

scaler: Option<Scalers>

draw: Option<bool>

synchronously_draw: Option<bool>

scaling_position_x: Option<f32>

scaling_position_y: Option<f32>

Trait Implementations

impl<'a> Default for UeConf<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Serialize for UeConf<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.