summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2019-12-20 11:20:09 +0100
committerMatthias Beyer <mail@beyermatthias.de>2019-12-20 11:20:09 +0100
commit0505704787744e6e425d553ae00d0a2a8cc6277b (patch)
tree0f30e4319f9e243011a6e0d80050ca8ff4040ff8
parent8aee739706222e67803b784257b7878a68ce84ac (diff)
Add documentation for IcalDuration
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
-rw-r--r--src/duration.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/duration.rs b/src/duration.rs
index d080584..6de4c49 100644
--- a/src/duration.rs
+++ b/src/duration.rs
@@ -5,17 +5,23 @@ use std::fmt::{Display, Error, Formatter};
use std::ops::{Add, Deref};
use std::str::FromStr;
+/// Duration type
+///
+/// A type that represents a duration of time
#[derive(Clone, Debug)]
pub struct IcalDuration {
duration: ical::icaldurationtype,
}
impl IcalDuration {
+
+ /// Convert a number of seconds to an IcalDuration
pub fn from_seconds(seconds: i32) -> IcalDuration {
let duration = unsafe { ical::icaldurationtype_from_int(seconds) };
IcalDuration { duration }
}
+ /// Get the number of seconds the IcalDuration represents
pub fn to_seconds(&self) -> i32 {
unsafe { ical::icaldurationtype_as_int(self.duration) }
}