1
Fork 0

Add missing urls for OpenOptions docs

This commit is contained in:
Guillaume Gomez 2017-09-13 14:46:15 +02:00
parent 7e5578da8c
commit ccd4689ca3

View file

@ -560,14 +560,20 @@ impl OpenOptions {
/// ///
/// One maybe obvious note when using append-mode: make sure that all data /// One maybe obvious note when using append-mode: make sure that all data
/// that belongs together is written to the file in one operation. This /// that belongs together is written to the file in one operation. This
/// can be done by concatenating strings before passing them to `write()`, /// can be done by concatenating strings before passing them to [`write()`],
/// or using a buffered writer (with a buffer of adequate size), /// or using a buffered writer (with a buffer of adequate size),
/// and calling `flush()` when the message is complete. /// and calling [`flush()`] when the message is complete.
/// ///
/// If a file is opened with both read and append access, beware that after /// If a file is opened with both read and append access, beware that after
/// opening, and after every write, the position for reading may be set at the /// opening, and after every write, the position for reading may be set at the
/// end of the file. So, before writing, save the current position (using /// end of the file. So, before writing, save the current position (using
/// `seek(SeekFrom::Current(0))`, and restore it before the next read. /// [`seek`]`(`[`SeekFrom`]`::`[`Current`]`(0))`, and restore it before the next read.
///
/// [`write()`]: ../../std/fs/struct.File.html#method.write
/// [`flush()`]: ../../std/fs/struct.File.html#method.flush
/// [`seek`]: ../../std/fs/struct.File.html#method.seek
/// [`SeekFrom`]: ../../std/io/enum.SeekFrom.html
/// [`Current`]: ../../std/io/enum.SeekFrom.html#variant.Current
/// ///
/// # Examples /// # Examples
/// ///
@ -605,9 +611,12 @@ impl OpenOptions {
/// This option indicates whether a new file will be created if the file /// This option indicates whether a new file will be created if the file
/// does not yet already exist. /// does not yet already exist.
/// ///
/// In order for the file to be created, `write` or `append` access must /// In order for the file to be created, [`write`] or [`append`] access must
/// be used. /// be used.
/// ///
/// [`write`]: #method.write
/// [`append`]: #method.append
///
/// # Examples /// # Examples
/// ///
/// ```no_run /// ```no_run
@ -630,12 +639,15 @@ impl OpenOptions {
/// whether a file exists and creating a new one, the file may have been /// whether a file exists and creating a new one, the file may have been
/// created by another process (a TOCTOU race condition / attack). /// created by another process (a TOCTOU race condition / attack).
/// ///
/// If `.create_new(true)` is set, `.create()` and `.truncate()` are /// If `.create_new(true)` is set, [`.create()`] and [`.truncate()`] are
/// ignored. /// ignored.
/// ///
/// The file must be opened with write or append access in order to create /// The file must be opened with write or append access in order to create
/// a new file. /// a new file.
/// ///
/// [`.create()`]: #method.create
/// [`.truncate()`]: #method.truncate
///
/// # Examples /// # Examples
/// ///
/// ```no_run /// ```no_run