tvl-depot/tvix/glue/src/tvix_io.rs
Florian Klink ddca074886 docs(tvix/glue/tvix_io): update doc-comments
Since we switched from reference scanning to string context, this only
handles the `__corepkgs__` hack. Update the docstrings.

Change-Id: Ie857c8c99ae1cdb4697323ec738f88be0580df3e
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12246
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
2024-08-19 10:24:37 +00:00

68 lines
2 KiB
Rust

//! This module implements a wrapper around tvix-eval's [EvalIO] type,
//! adding functionality which is required by tvix-cli:
//!
//! 1. Handling the C++ Nix `__corepkgs__`-hack for nixpkgs bootstrapping.
//!
//! All uses of [EvalIO] in tvix-cli must make use of this wrapper,
//! otherwise nixpkgs bootstrapping will not work.
use std::io::{self, Cursor};
use std::path::{Path, PathBuf};
use tvix_eval::{EvalIO, FileType};
// TODO: Merge this together with TvixStoreIO?
pub struct TvixIO<T> {
// Actual underlying [EvalIO] implementation.
actual: T,
}
impl<T> TvixIO<T> {
pub fn new(actual: T) -> Self {
Self { actual }
}
}
impl<T> EvalIO for TvixIO<T>
where
T: AsRef<dyn EvalIO>,
{
fn store_dir(&self) -> Option<String> {
self.actual.as_ref().store_dir()
}
fn import_path(&self, path: &Path) -> io::Result<PathBuf> {
self.actual.as_ref().import_path(path)
}
fn path_exists(&self, path: &Path) -> io::Result<bool> {
if path.starts_with("/__corepkgs__") {
return Ok(true);
}
self.actual.as_ref().path_exists(path)
}
fn open(&self, path: &Path) -> io::Result<Box<dyn io::Read>> {
// Bundled version of corepkgs/fetchurl.nix. The counterpart
// of this happens in [crate::configure_nix_path], where the `nix_path`
// of the evaluation has `nix=/__corepkgs__` added to it.
//
// This workaround is similar to what cppnix does for passing
// the path through.
//
// TODO: this comparison is bad we should use the sane path library.
if path.starts_with("/__corepkgs__/fetchurl.nix") {
return Ok(Box::new(Cursor::new(include_bytes!("fetchurl.nix"))));
}
self.actual.as_ref().open(path)
}
fn file_type(&self, path: &Path) -> io::Result<FileType> {
self.actual.as_ref().file_type(path)
}
fn read_dir(&self, path: &Path) -> io::Result<Vec<(bytes::Bytes, FileType)>> {
self.actual.as_ref().read_dir(path)
}
}