Added Rust documentation comments for Version and Mask struct+impl.

pull/40/head
Project Nayuki 6 years ago
parent 38d8d3377f
commit d234e1c73b

@ -1220,30 +1220,40 @@ impl BitBuffer {
/*---- Miscellaneous values ----*/ /*---- Miscellaneous values ----*/
/// A number between 1 and 40 (inclusive).
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
pub struct Version(u8); pub struct Version(u8);
impl Version { impl Version {
/// Creates a version object from the given number.
///
/// Panics if the number is outside the range [1, 40].
pub fn new(ver: u8) -> Self { pub fn new(ver: u8) -> Self {
assert!(QrCode_MIN_VERSION.value() <= ver && ver <= QrCode_MAX_VERSION.value(), "Version number out of range"); assert!(QrCode_MIN_VERSION.value() <= ver && ver <= QrCode_MAX_VERSION.value(), "Version number out of range");
Version(ver) Version(ver)
} }
/// Returns the value, which is in the range [1, 40].
pub fn value(&self) -> u8 { pub fn value(&self) -> u8 {
self.0 self.0
} }
} }
/// A number between 0 and 7 (inclusive).
#[derive(Copy, Clone)] #[derive(Copy, Clone)]
pub struct Mask(u8); pub struct Mask(u8);
impl Mask { impl Mask {
/// Creates a mask object from the given number.
///
/// Panics if the number is outside the range [0, 7].
pub fn new(mask: u8) -> Self { pub fn new(mask: u8) -> Self {
assert!(mask <= 7, "Mask value out of range"); assert!(mask <= 7, "Mask value out of range");
Mask(mask) Mask(mask)
} }
/// Returns the value, which is in the range [0, 7].
pub fn value(&self) -> u8 { pub fn value(&self) -> u8 {
self.0 self.0
} }

Loading…
Cancel
Save