Struct MonitorLayoutEntry 

pub struct MonitorLayoutEntry { /* private fields */ }

[2.2.2.2.1] DISPLAYCONTROL_MONITOR_LAYOUT_PDU

Implementations

impl MonitorLayoutEntry

pub fn adjust_display_size(width: u32, height: u32) -> (u32, u32)

Adjusts the display size to be within the valid range.

Per [2.2.2.2.1]:

• The width MUST be greater than or equal to 200 pixels and less than or equal to 8192 pixels, and MUST NOT be an odd value.
• The height MUST be greater than or equal to 200 pixels and less than or equal to 8192 pixels.

Functions that create MonitorLayoutEntry should typically use this function to adjust the display size first.

pub fn new_primary(width: u32, height: u32) -> EncodeResult<Self>

Creates a new primary MonitorLayoutEntry.

Per [2.2.2.2.1]:

• The width MUST be greater than or equal to 200 pixels and less than or equal to 8192 pixels, and MUST NOT be an odd value.
• The height MUST be greater than or equal to 200 pixels and less than or equal to 8192 pixels.

Use MonitorLayoutEntry::adjust_display_size before calling this function to ensure the display size is within the valid range.

pub fn new_secondary(width: u32, height: u32) -> EncodeResult<Self>

Creates a new primary MonitorLayoutEntry.

Per [2.2.2.2.1]:

• The width MUST be greater than or equal to 200 pixels and less than or equal to 8192 pixels, and MUST NOT be an odd value.
• The height MUST be greater than or equal to 200 pixels and less than or equal to 8192 pixels.

Use MonitorLayoutEntry::adjust_display_size before calling this function to ensure the display size is within the valid range.

pub fn with_orientation(self, orientation: MonitorOrientation) -> Self

Sets the monitor’s orientation. (Default is MonitorOrientation::Landscape)

pub fn with_position(self, left: i32, top: i32) -> EncodeResult<Self>

Sets the monitor’s position (left, top) in pixels. (Default is (0, 0))

Note: The primary monitor position must be always (0, 0).

pub fn with_device_scale_factor( self, device_scale_factor: DeviceScaleFactor, ) -> Self

Sets the monitor’s device scale factor in percent. (Default is DeviceScaleFactor::Scale100Percent)

pub fn with_desktop_scale_factor( self, desktop_scale_factor: u32, ) -> EncodeResult<Self>

Sets the monitor’s desktop scale factor in percent.

NOTE: As specified in [MS-RDPEDISP], if the desktop scale factor is not in the valid range (100..=500 percent), the monitor desktop scale factor is considered invalid and should be ignored.

pub fn with_physical_dimensions( self, physical_width: u32, physical_height: u32, ) -> EncodeResult<Self>

Sets the monitor’s physical dimensions in millimeters.

NOTE: As specified in [MS-RDPEDISP], if the physical dimensions are not in the valid range (10..=10000 millimeters), the monitor physical dimensions are considered invalid and should be ignored.

pub fn is_primary(&self) -> bool

pub fn position(&self) -> Option<(i32, i32)>

Returns the monitor’s position (left, top) in pixels.

pub fn dimensions(&self) -> (u32, u32)

Returns the monitor’s dimensions (width, height) in pixels.

pub fn orientation(&self) -> Option<MonitorOrientation>

Returns the monitor’s orientation if it is valid.

NOTE: As specified in [MS-RDPEDISP], if the orientation is not one of the valid values (0, 90, 180, 270), the monitor orientation is considered invalid and should be ignored.

pub fn physical_dimensions(&self) -> Option<(u32, u32)>

Returns the monitor’s physical dimensions (width, height) in millimeters.

NOTE: As specified in [MS-RDPEDISP], if the physical dimensions are not in the valid range (10..=10000 millimeters), the monitor physical dimensions are considered invalid and should be ignored.

pub fn desktop_scale_factor(&self) -> Option<u32>

Returns the monitor’s device scale factor in percent if it is valid.

NOTE: As specified in [MS-RDPEDISP], if the desktop scale factor is not in the valid range (100..=500 percent), the monitor desktop scale factor is considered invalid and should be ignored.

IMPORTANT: When processing scale factors, make sure that both desktop and device scale factors are valid, otherwise they both should be ignored.

pub fn device_scale_factor(&self) -> Option<DeviceScaleFactor>

Returns the monitor’s device scale factor in percent if it is valid.

IMPORTANT: When processing scale factors, make sure that both desktop and device scale factors are valid, otherwise they both should be ignored.

Trait Implementations

impl Clone for MonitorLayoutEntry

fn clone(&self) -> MonitorLayoutEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MonitorLayoutEntry

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

Formats the value using the given formatter.

impl<'de> Decode<'de> for MonitorLayoutEntry

fn decode(src: &mut ReadCursor<'de>) -> DecodeResult<Self>

Decodes an instance of Self from the given byte stream.

impl Encode for MonitorLayoutEntry

fn encode(&self, dst: &mut WriteCursor<'_>) -> EncodeResult<()>

Encodes this PDU in-place using the provided WriteCursor.

fn name(&self) -> &'static str

Returns the associated PDU name associated.

fn size(&self) -> usize

Computes the size in bytes for this PDU.

impl PartialEq for MonitorLayoutEntry

fn eq(&self, other: &MonitorLayoutEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MonitorLayoutEntry

impl StructuralPartialEq for MonitorLayoutEntry