Skip to main content

Display

Struct Display 

Source
pub struct Display {
    pub name: String,
    pub width: f64,
    pub height: f64,
    pub background: Color,
    pub macros: Macros,
    pub widgets: Vec<Widget>,
    pub source: Option<Source>,
    pub legacy: bool,
    pub size: usize,
}
Expand description

A parsed .bob (or translated .opi) display.

Fields§

§name: String§width: f64§height: f64§background: Color§macros: Macros§widgets: Vec<Widget>§source: Option<Source>

The file or URL it was read from, used to resolve relative paths.

§legacy: bool

Translated from a BOY .opi file. BOY clipped widgets to the declared size, where Phoebus grows the display to show them.

§size: usize

The size of the file’s XML, in bytes.

Implementations§

Source§

impl Display

Source

pub fn load(path: &Path) -> Result<Self, Error>

Read the display file at path, which may lie in an Eclipse project’s linked folder (see project). A real BOY screen beside a DLS launcher is taken through the launcher’s project (see project::launcher_path), so the files it names do too; any other display reached through a launcher’s project goes by its real path.

Source

pub fn parse(xml: &str) -> Result<Self, Error>

Source

pub fn resolve(&self, file: &str) -> Source

Resolve a file named by this display (e.g. in an action) against its location.

Source

pub fn all_widgets(&self) -> Vec<&Widget>

Every widget, depth first.

Trait Implementations§

Source§

impl Clone for Display

Source§

fn clone(&self) -> Display

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Display

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.