Struct HwpUnit 

pub struct HwpUnit(/* private fields */);

The universal measurement unit used throughout HWP documents.

Internally an i32 where 1 point = 100 HwpUnit. repr(transparent) guarantees zero overhead over a bare i32.

FROZEN: Do not change the internal representation after v1.0.

Valid Range

[-100_000_000, 100_000_000] – comfortably covers A0 paper (841 mm width ~ 2_384_252 HwpUnit).

Examples

use hwpforge_foundation::HwpUnit;

let one_inch = HwpUnit::from_inch(1.0).unwrap();
assert_eq!(one_inch.as_i32(), 7200);

Implementations

impl HwpUnit

pub const MIN_VALUE: i32 = -100_000_000

Minimum valid value (inclusive).

pub const MAX_VALUE: i32 = 100_000_000

Maximum valid value (inclusive).

pub const ZERO: Self

Zero HwpUnit.

pub const ONE_PT: Self

One typographic point (100 HwpUnit).

pub fn new(value: i32) -> FoundationResult<Self>

Creates an HwpUnit from a raw i32, validating the range.

Errors

Returns FoundationError::InvalidHwpUnit when value lies outside [MIN_VALUE, MAX_VALUE].

Examples

use hwpforge_foundation::HwpUnit;

assert!(HwpUnit::new(0).is_ok());
assert!(HwpUnit::new(200_000_000).is_err());

pub const fn as_i32(self) -> i32

Returns the raw i32 value.

pub const fn is_zero(&self) -> bool

Returns true if this unit is zero.

Useful as a skip_serializing_if predicate for serde.

pub fn from_pt(pt: f64) -> FoundationResult<Self>

Constructs an HwpUnit from typographic points.

Errors

Returns an error when pt is non-finite or the converted value exceeds the valid range.

Examples

use hwpforge_foundation::HwpUnit;

let u = HwpUnit::from_pt(12.0).unwrap();
assert_eq!(u.as_i32(), 1200);

pub fn from_mm(mm: f64) -> FoundationResult<Self>

Constructs an HwpUnit from millimeters.

Errors

Returns an error when mm is non-finite or the converted value exceeds the valid range.

pub fn from_inch(inch: f64) -> FoundationResult<Self>

Constructs an HwpUnit from inches.

Errors

Returns an error when inch is non-finite or the converted value exceeds the valid range.

pub fn to_pt(self) -> f64

Converts to typographic points (f64).

pub fn to_mm(self) -> f64

Converts to millimeters (f64).

pub fn to_inch(self) -> f64

Converts to inches (f64).

Trait Implementations

impl Add for HwpUnit

type Output = HwpUnit

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl Clone for HwpUnit

fn clone(&self) -> HwpUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HwpUnit

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

Formats the value using the given formatter.

impl Default for HwpUnit

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HwpUnit

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for HwpUnit

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

Formats the value using the given formatter.

impl Div<i32> for HwpUnit

type Output = HwpUnit

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> Self

Performs the / operation.

impl Hash for HwpUnit

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for HwpUnit

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Mul<i32> for HwpUnit

type Output = HwpUnit

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Self

Performs the * operation.

impl Neg for HwpUnit

type Output = HwpUnit

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for HwpUnit

fn cmp(&self, other: &HwpUnit) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HwpUnit

fn eq(&self, other: &HwpUnit) -> 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 PartialOrd for HwpUnit

fn partial_cmp(&self, other: &HwpUnit) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for HwpUnit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for HwpUnit

type Output = HwpUnit

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl Copy for HwpUnit

impl Eq for HwpUnit

impl StructuralPartialEq for HwpUnit