docfs.rs - source

Files

cargo_fmt

coverage_test_macros

git_rustfmt

rustc_apfloat

ieee.rs lib.rs ppc.rs

rustc_arena

rustc_ast

attr

expand

allocator.rs mod.rs

util

classify.rs comments.rs literal.rs parser.rs

ast.rs ast_like.rs entry.rs lib.rs mut_visit.rs node_id.rs ptr.rs token.rs tokenstream.rs visit.rs

rustc_ast_lowering

asm.rs block.rs expr.rs index.rs item.rs lib.rs pat.rs path.rs

rustc_ast_passes

ast_validation.rs feature_gate.rs lib.rs node_count.rs show_span.rs

rustc_ast_pretty

pprust

mod.rs state.rs

helpers.rs lib.rs pp.rs

rustc_attr

builtin.rs lib.rs

rustc_borrowck

rustc_builtin_macros

rustc_codegen_llvm

rustc_codegen_ssa

rustc_const_eval

rustc_data_structures

binary_search_util

graph

dominators

implementation

iterate

scc

vec_graph

mod.rs reference.rs

obligation_forest

graphviz.rs mod.rs

owning_ref

snapshot_map

sorted_map

sso

either_iter.rs map.rs mod.rs set.rs

tagged_ptr

copy.rs drop.rs

rustc_driver

args.rs lib.rs pretty.rs

rustc_error_codes

error_codes.rs lib.rs

rustc_errors

annotate_snippet_emitter_writer.rs diagnostic.rs diagnostic_builder.rs emitter.rs json.rs lib.rs lock.rs registry.rs snippet.rs styled_buffer.rs

rustc_expand

mbe

macro_check.rs macro_parser.rs macro_rules.rs quoted.rs transcribe.rs

base.rs build.rs config.rs expand.rs lib.rs mbe.rs module.rs placeholders.rs proc_macro.rs proc_macro_server.rs

rustc_feature

accepted.rs active.rs builtin_attrs.rs lib.rs removed.rs

rustc_fs_util

rustc_graphviz

rustc_hir

arena.rs def.rs def_path_hash_map.rs definitions.rs diagnostic_items.rs hir.rs hir_id.rs intravisit.rs itemlikevisit.rs lang_items.rs lib.rs pat_util.rs stable_hash_impls.rs target.rs weak_lang_items.rs

rustc_hir_pretty

rustc_incremental

persist

data.rs dirty_clean.rs file_format.rs fs.rs load.rs mod.rs save.rs work_product.rs

assert_dep_graph.rs assert_module_sources.rs lib.rs

rustc_index

bit_set.rs lib.rs vec.rs

rustc_infer

infer

canonical

canonicalizer.rs mod.rs query_response.rs substitute.rs

error_reporting

nice_region_error

different_lifetimes.rs find_anon_type.rs mismatched_static_lifetime.rs mod.rs named_anon_conflict.rs placeholder_error.rs static_impl_trait.rs trait_impl_difference.rs util.rs

mod.rs need_type_info.rs note.rs

higher_ranked

lexical_region_resolve

nll_relate

outlives

components.rs env.rs mod.rs obligations.rs verify.rs

region_constraints

leak_check.rs mod.rs

at.rs combine.rs equate.rs free_regions.rs freshen.rs fudge.rs glb.rs lattice.rs lub.rs mod.rs opaque_types.rs projection.rs resolve.rs sub.rs type_variable.rs undo_log.rs

traits

error_reporting

engine.rs mod.rs project.rs structural_impls.rs util.rs

rustc_interface

callbacks.rs interface.rs lib.rs passes.rs proc_macro_decls.rs queries.rs util.rs

rustc_lexer

cursor.rs lib.rs unescape.rs

rustc_lint

array_into_iter.rs builtin.rs context.rs early.rs enum_intrinsics_non_enums.rs internal.rs late.rs levels.rs lib.rs methods.rs non_ascii_idents.rs non_fmt_panic.rs nonstandard_style.rs noop_method_call.rs passes.rs redundant_semicolon.rs traits.rs types.rs unused.rs

rustc_lint_defs

builtin.rs lib.rs

rustc_llvm

rustc_macros

hash_stable.rs lib.rs lift.rs query.rs serialize.rs session_diagnostic.rs symbols.rs type_foldable.rs

rustc_metadata

rmeta

decoder

decoder.rs def_path_hash_map.rs encoder.rs mod.rs table.rs

creader.rs dependency_format.rs dynamic_lib.rs foreign_modules.rs lib.rs locator.rs native_libs.rs

rustc_middle

dep_graph

dep_node.rs mod.rs

hir

map

blocks.rs mod.rs

exports.rs mod.rs place.rs

infer

canonical.rs mod.rs unify_key.rs

middle

codegen_fn_attrs.rs dependency_format.rs exported_symbols.rs lang_items.rs limits.rs mod.rs privacy.rs region.rs resolve_lifetime.rs stability.rs

mir

query

thir

abstract_const.rs visit.rs

traits

chalk.rs mod.rs query.rs select.rs specialization_graph.rs structural_impls.rs

ty

util

bug.rs common.rs

arena.rs lib.rs lint.rs macros.rs thir.rs

rustc_mir_build

rustc_mir_dataflow

rustc_mir_transform

rustc_monomorphize

partitioning

default.rs merging.rs mod.rs

collector.rs lib.rs polymorphize.rs util.rs

rustc_parse

lexer

mod.rs tokentrees.rs unescape_error_reporting.rs unicode_chars.rs

parser

attr.rs attr_wrapper.rs diagnostics.rs expr.rs generics.rs item.rs mod.rs nonterminal.rs pat.rs path.rs stmt.rs ty.rs

lib.rs validate_attr.rs

rustc_parse_format

rustc_passes

rustc_plugin_impl

rustc_privacy

rustc_query_impl

keys.rs lib.rs on_disk_cache.rs plumbing.rs profiling_support.rs stats.rs util.rs values.rs

rustc_query_system

dep_graph

debug.rs dep_node.rs graph.rs mod.rs query.rs serialized.rs

ich

hcx.rs impls_hir.rs impls_syntax.rs mod.rs

query

caches.rs config.rs job.rs mod.rs plumbing.rs

cache.rs lib.rs

rustc_resolve

late

diagnostics.rs lifetimes.rs

build_reduced_graph.rs check_unused.rs def_collector.rs diagnostics.rs imports.rs late.rs lib.rs macros.rs

rustc_save_analysis

dump_visitor.rs dumper.rs lib.rs sig.rs span_utils.rs

rustc_serialize

collection_impls.rs json.rs leb128.rs lib.rs opaque.rs serialize.rs

rustc_session

cgu_reuse_tracker.rs code_stats.rs config.rs cstore.rs filesearch.rs lib.rs options.rs output.rs parse.rs search_paths.rs session.rs utils.rs

rustc_span

analyze_source_file.rs caching_source_map_view.rs def_id.rs edition.rs fatal_error.rs hygiene.rs lev_distance.rs lib.rs source_map.rs span_encoding.rs symbol.rs

rustc_symbol_mangling

legacy.rs lib.rs test.rs v0.rs

rustc_target

abi

asm

aarch64.rs arm.rs bpf.rs hexagon.rs mips.rs mod.rs nvptx.rs powerpc.rs riscv.rs s390x.rs spirv.rs wasm.rs x86.rs

spec

aarch64_apple_darwin.rs aarch64_apple_ios.rs aarch64_apple_ios_macabi.rs aarch64_apple_ios_sim.rs aarch64_apple_tvos.rs aarch64_be_unknown_linux_gnu.rs aarch64_be_unknown_linux_gnu_ilp32.rs aarch64_fuchsia.rs aarch64_kmc_solid_asp3.rs aarch64_linux_android.rs aarch64_pc_windows_msvc.rs aarch64_unknown_freebsd.rs aarch64_unknown_hermit.rs aarch64_unknown_linux_gnu.rs aarch64_unknown_linux_gnu_ilp32.rs aarch64_unknown_linux_musl.rs aarch64_unknown_netbsd.rs aarch64_unknown_none.rs aarch64_unknown_none_softfloat.rs aarch64_unknown_openbsd.rs aarch64_unknown_redox.rs aarch64_unknown_uefi.rs aarch64_uwp_windows_msvc.rs aarch64_wrs_vxworks.rs abi.rs android_base.rs apple_base.rs apple_sdk_base.rs arm_linux_androideabi.rs arm_unknown_linux_gnueabi.rs arm_unknown_linux_gnueabihf.rs arm_unknown_linux_musleabi.rs arm_unknown_linux_musleabihf.rs armebv7r_none_eabi.rs armebv7r_none_eabihf.rs armv4t_unknown_linux_gnueabi.rs armv5te_unknown_linux_gnueabi.rs armv5te_unknown_linux_musleabi.rs armv5te_unknown_linux_uclibceabi.rs armv6_unknown_freebsd.rs armv6_unknown_netbsd_eabihf.rs armv6k_nintendo_3ds.rs armv7_apple_ios.rs armv7_linux_androideabi.rs armv7_unknown_freebsd.rs armv7_unknown_linux_gnueabi.rs armv7_unknown_linux_gnueabihf.rs armv7_unknown_linux_musleabi.rs armv7_unknown_linux_musleabihf.rs armv7_unknown_linux_uclibceabihf.rs armv7_unknown_netbsd_eabihf.rs armv7_wrs_vxworks_eabihf.rs armv7a_kmc_solid_asp3_eabi.rs armv7a_kmc_solid_asp3_eabihf.rs armv7a_none_eabi.rs armv7a_none_eabihf.rs armv7r_none_eabi.rs armv7r_none_eabihf.rs armv7s_apple_ios.rs asmjs_unknown_emscripten.rs avr_gnu_base.rs avr_unknown_gnu_atmega328.rs bpf_base.rs bpfeb_unknown_none.rs bpfel_unknown_none.rs crt_objects.rs dragonfly_base.rs freebsd_base.rs fuchsia_base.rs haiku_base.rs hermit_base.rs hermit_kernel_base.rs hexagon_unknown_linux_musl.rs i386_apple_ios.rs i586_pc_windows_msvc.rs i586_unknown_linux_gnu.rs i586_unknown_linux_musl.rs i686_apple_darwin.rs i686_linux_android.rs i686_pc_windows_gnu.rs i686_pc_windows_msvc.rs i686_unknown_freebsd.rs i686_unknown_haiku.rs i686_unknown_linux_gnu.rs i686_unknown_linux_musl.rs i686_unknown_netbsd.rs i686_unknown_openbsd.rs i686_unknown_uefi.rs i686_uwp_windows_gnu.rs i686_uwp_windows_msvc.rs i686_wrs_vxworks.rs illumos_base.rs l4re_base.rs linux_base.rs linux_gnu_base.rs linux_kernel_base.rs linux_musl_base.rs linux_uclibc_base.rs m68k_unknown_linux_gnu.rs mips64_unknown_linux_gnuabi64.rs mips64_unknown_linux_muslabi64.rs mips64el_unknown_linux_gnuabi64.rs mips64el_unknown_linux_muslabi64.rs mips_unknown_linux_gnu.rs mips_unknown_linux_musl.rs mips_unknown_linux_uclibc.rs mipsel_sony_psp.rs mipsel_unknown_linux_gnu.rs mipsel_unknown_linux_musl.rs mipsel_unknown_linux_uclibc.rs mipsel_unknown_none.rs mipsisa32r6_unknown_linux_gnu.rs mipsisa32r6el_unknown_linux_gnu.rs mipsisa64r6_unknown_linux_gnuabi64.rs mipsisa64r6el_unknown_linux_gnuabi64.rs mod.rs msp430_none_elf.rs msvc_base.rs netbsd_base.rs nvptx64_nvidia_cuda.rs openbsd_base.rs powerpc64_unknown_freebsd.rs powerpc64_unknown_linux_gnu.rs powerpc64_unknown_linux_musl.rs powerpc64_wrs_vxworks.rs powerpc64le_unknown_freebsd.rs powerpc64le_unknown_linux_gnu.rs powerpc64le_unknown_linux_musl.rs powerpc_unknown_freebsd.rs powerpc_unknown_linux_gnu.rs powerpc_unknown_linux_gnuspe.rs powerpc_unknown_linux_musl.rs powerpc_unknown_netbsd.rs powerpc_unknown_openbsd.rs powerpc_wrs_vxworks.rs powerpc_wrs_vxworks_spe.rs redox_base.rs riscv32gc_unknown_linux_gnu.rs riscv32gc_unknown_linux_musl.rs riscv32i_unknown_none_elf.rs riscv32imac_unknown_none_elf.rs riscv32imc_esp_espidf.rs riscv32imc_unknown_none_elf.rs riscv64gc_unknown_linux_gnu.rs riscv64gc_unknown_linux_musl.rs riscv64gc_unknown_none_elf.rs riscv64imac_unknown_none_elf.rs s390x_unknown_linux_gnu.rs s390x_unknown_linux_musl.rs solaris_base.rs solid_base.rs sparc64_unknown_linux_gnu.rs sparc64_unknown_netbsd.rs sparc64_unknown_openbsd.rs sparc_unknown_linux_gnu.rs sparcv9_sun_solaris.rs thumb_base.rs thumbv4t_none_eabi.rs thumbv6m_none_eabi.rs thumbv7a_pc_windows_msvc.rs thumbv7a_uwp_windows_msvc.rs thumbv7em_none_eabi.rs thumbv7em_none_eabihf.rs thumbv7m_none_eabi.rs thumbv7neon_linux_androideabi.rs thumbv7neon_unknown_linux_gnueabihf.rs thumbv7neon_unknown_linux_musleabihf.rs thumbv8m_base_none_eabi.rs thumbv8m_main_none_eabi.rs thumbv8m_main_none_eabihf.rs uefi_msvc_base.rs vxworks_base.rs wasm32_unknown_emscripten.rs wasm32_unknown_unknown.rs wasm32_wasi.rs wasm64_unknown_unknown.rs wasm_base.rs windows_gnu_base.rs windows_msvc_base.rs windows_uwp_gnu_base.rs windows_uwp_msvc_base.rs x86_64_apple_darwin.rs x86_64_apple_ios.rs x86_64_apple_ios_macabi.rs x86_64_apple_tvos.rs x86_64_fortanix_unknown_sgx.rs x86_64_fuchsia.rs x86_64_linux_android.rs x86_64_pc_solaris.rs x86_64_pc_windows_gnu.rs x86_64_pc_windows_msvc.rs x86_64_sun_solaris.rs x86_64_unknown_dragonfly.rs x86_64_unknown_freebsd.rs x86_64_unknown_haiku.rs x86_64_unknown_hermit.rs x86_64_unknown_illumos.rs x86_64_unknown_l4re_uclibc.rs x86_64_unknown_linux_gnu.rs x86_64_unknown_linux_gnux32.rs x86_64_unknown_linux_musl.rs x86_64_unknown_netbsd.rs x86_64_unknown_none_hermitkernel.rs x86_64_unknown_none_linuxkernel.rs x86_64_unknown_openbsd.rs x86_64_unknown_redox.rs x86_64_unknown_uefi.rs x86_64_uwp_windows_gnu.rs x86_64_uwp_windows_msvc.rs x86_64_wrs_vxworks.rs

rustc_trait_selection

rustc_traits

chalk

db.rs lowering.rs mod.rs

dropck_outlives.rs evaluate_obligation.rs implied_outlives_bounds.rs lib.rs normalize_erasing_regions.rs normalize_projection_ty.rs type_op.rs

rustc_ty_utils

common_traits.rs instance.rs lib.rs needs_drop.rs representability.rs ty.rs

rustc_type_ir

rustc_typeck

bounds.rs check_unused.rs collect.rs constrained_generic_params.rs errors.rs expr_use_visitor.rs hir_wf_check.rs impl_wf_check.rs lib.rs mem_categorization.rs structured_errors.rs

rustdoc

rustdoc_json_types

rustfmt

rustfmt_format_diff

rustfmt_nightly

//! Rustdoc's FileSystem abstraction module.
//!
//! On Windows this indirects IO into threads to work around performance issues
//! with Defender (and other similar virus scanners that do blocking operations).
//! On other platforms this is a thin shim to fs.
//!
//! Only calls needed to permit this workaround have been abstracted: thus
//! fs::read is still done directly via the fs module; if in future rustdoc
//! needs to read-after-write from a file, then it would be added to this
//! abstraction.

use std::fs;
use std::io;
use std::path::{Path, PathBuf};
use std::string::ToString;
use std::sync::mpsc::Sender;

macro_rules! try_err {
    ($e:expr, $file:expr) => {
        match $e {
            Ok(e) => e,
            Err(e) => return Err(E::new(e, $file)),
        }
    };
}

crate trait PathError {
    fn new<S, P: AsRef<Path>>(e: S, path: P) -> Self
    where
        S: ToString + Sized;
}

crate struct DocFS {
    sync_only: bool,
    errors: Option<Sender<String>>,
}

impl DocFS {
    crate fn new(errors: Sender<String>) -> DocFS {
        DocFS { sync_only: false, errors: Some(errors) }
    }

    crate fn set_sync_only(&mut self, sync_only: bool) {
        self.sync_only = sync_only;
    }

    crate fn close(&mut self) {
        self.errors = None;
    }

    crate fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
        // For now, dir creation isn't a huge time consideration, do it
        // synchronously, which avoids needing ordering between write() actions
        // and directory creation.
        fs::create_dir_all(path)
    }

    crate fn write<E>(
        &self,
        path: PathBuf,
        contents: impl 'static + Send + AsRef<[u8]>,
    ) -> Result<(), E>
    where
        E: PathError,
    {
        if !self.sync_only && cfg!(windows) {
            // A possible future enhancement after more detailed profiling would
            // be to create the file sync so errors are reported eagerly.
            let sender = self.errors.clone().expect("can't write after closing");
            rayon::spawn(move || {
                fs::write(&path, contents).unwrap_or_else(|e| {
                    sender.send(format!("\"{}\": {}", path.display(), e)).unwrap_or_else(|_| {
                        panic!("failed to send error on \"{}\"", path.display())
                    })
                });
            });
        } else {
            try_err!(fs::write(&path, contents), path);
        }
        Ok(())
    }
}