Struct XHandle

pub struct XHandle { /* private fields */ }

Implementations

impl XHandle

pub fn open() -> Result<Self, XrandrError>

Open a handle to the lib-xrandr backend. This will be used for nearly all interactions with the xrandr lib

Errors

• XrandrError::Open - Getting the handle failed.

Examples

let xhandle = XHandle.open()?;
let mon1 = xhandle.monitors()?[0];

pub fn monitors(&mut self) -> Result<Vec<Monitor>, XrandrError>

List every monitor

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let mon1 = xhandle.monitors()?[0];

pub fn all_outputs(&mut self) -> Result<Vec<Output>, XrandrError>

List every monitor’s outputs

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = xhandle.all_outputs()?[0];

pub fn enable(&mut self, output: &Output) -> Result<(), XrandrError>

Enable the given output by setting it to its preferred mode

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = xhandle.all_outputs()?[0];
xhandle.enable(dp_1)?;

pub fn disable(&mut self, output: &Output) -> Result<(), XrandrError>

Disable the given output

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = xhandle.all_outputs()?[0];
xhandle.disable(dp_1)?;

pub fn set_primary(&mut self, o: &Output)

Sets the given output as the primary output

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = xhandle.all_outputs()?[0];
xhandle.set_primary(dp_1)?;

pub fn set_mode( &mut self, output: &Output, mode: &Mode, ) -> Result<(), XrandrError>

Sets the mode of a given output, relative to another

Arguments

• output - The output to change mode for
• mode - The mode to change to

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = xhandle.all_outputs()?[0];
let mode = dp_1.preferred_modes[0];
xhandle.set_mode(dp_1, mode)?;

pub fn set_position( &mut self, output: &Output, relation: &Relation, relative_output: &Output, ) -> Result<(), XrandrError>

Sets the position of a given output, relative to another

Arguments

• output - The output to reposition
• relation - The relation output will have to rel_output
• rel_output - The output to position relative to

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = outputs[0];
let hdmi_1 = outputs[3];
xhandle.set_position(dp_1, Relation::LeftOf, hdmi_1)?;

pub fn set_rotation( &mut self, output: &Output, rotation: &Rotation, ) -> Result<(), XrandrError>

Sets the position of a given output, relative to another

Arguments

• output - The output to rotate
• rotation

Errors

• XrandrError::_ - various calls to the xrandr backend may fail

Examples

let dp_1 = outputs[0];
xhandle.set_rotation(dp_1, Rotation::Inverted)?;

Trait Implementations

impl Debug for XHandle

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

Formats the value using the given formatter.

impl Drop for XHandle

fn drop(&mut self)

Executes the destructor for this type.