add documentation for duration_to_string (with example) and make it public

This commit is contained in:
OMGeeky
2023-06-21 18:30:40 +02:00
parent 0a6c5383b0
commit a4cf5860a3

View File

@@ -829,7 +829,17 @@ fn get_date_string_from_video(video: &VideoData) -> Result<String> {
//endregion
fn duration_to_string(duration: &Duration) -> String {
/// Converts a duration to a string that is usable for example in a youtube title
///
/// Example:
///
/// ```
/// use chrono::Duration;
/// let duration: Duration = Duration::seconds(20);
/// let s = downloader::duration_to_string(&duration);
/// assert_eq!(s, "00:00:20");
/// ```
pub fn duration_to_string(duration: &Duration) -> String {
trace!("duration to string for duration: {:?}", duration);
let seconds = duration.num_seconds();
let hours = seconds / 3600;