Skip to content

Commit

Permalink
docs: Update description for to_dos_date_time and from_dos_date_time
Browse files Browse the repository at this point in the history
  • Loading branch information
sorairolake committed Jan 10, 2025
1 parent 33dba84 commit bb9b53e
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/file_time/dos_date_time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,22 @@ impl FileTime {
/// a multiple of 15 minute intervals, returns the UTC date and time as a
/// date and time and [`None`] as the UTC offset.
///
/// Note that exFAT supports `resolution` for creation and last modified
/// times, and the `offset` return value for these times and last access
/// time, but other file systems and file formats may not support these. For
/// example, the built-in timestamp of ZIP used for last modified time only
/// records `date` and `time`, not `resolution` and the `offset` return
/// value.
///
/// # Errors
///
/// Returns [`Err`] if the resulting date and time is out of range for
/// MS-DOS date and time.
///
/// # Panics
///
/// Panics if `offset` is out of range for the [OffsetFromUtc field].
/// Panics if the `offset` parameter is out of range for the [OffsetFromUtc
/// field].
///
/// # Examples
///
Expand Down Expand Up @@ -173,6 +181,12 @@ impl FileTime {
/// [`None`] or is not a multiple of 15 minute intervals, assumes the
/// provided date and time is in UTC.
///
/// Note that exFAT supports `resolution` for creation and last modified
/// times, and `offset` for these times and last access time, but other file
/// systems and file formats may not support these. For example, the
/// built-in timestamp of ZIP used for last modified time only records
/// `date` and `time`, not `resolution` and `offset`.
///
/// # Errors
///
/// Returns [`Err`] if `date` or `time` is an invalid date and time.
Expand Down

0 comments on commit bb9b53e

Please sign in to comment.