0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-09-30 04:38:52 +02:00

ircd::fs: Add additional write_opts comments.

This commit is contained in:
Jason Volk 2018-11-01 20:26:31 -07:00
parent 13e6e02901
commit a62469a9d6

View file

@ -41,10 +41,17 @@ struct ircd::fs::write_opts
write_opts() = default;
write_opts(const off_t &);
/// Offset in the file to start the write from.
/// Offset in the file to start the write from. For append() if this zero
/// then it will be internally set to the end of the file; otherwise if
/// this is set it will write to that offset, even for append(), unless
/// the host system later ignores the offset due to the file's openmode.
off_t offset {0};
/// Alignment requirement.
/// Alignment requirement value. This value may take on several meanings
/// and should remain zero for most users. Most users should conduct their
/// own alignment of userspace buffer addresses and sizes and file offsets.
/// Currently for append() this will zero-extend a write to the alignment
/// leading to a file which may be larger than the user expects with gaps.
size_t alignment {0};
/// Request priority. Higher value request will take priority over lower