buffrs 0.13.0

Modern protobuf package management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

// Copyright 2025 Helsing GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![warn(missing_docs)]
#![doc = include_str!("../README.md")]

use std::{env, path::PathBuf};

use miette::Diagnostic;
use thiserror::Error;

/// Caching implementation
pub mod cache;
/// CLI command implementations
pub mod command;
/// Credential management
pub mod credentials;
/// Common error types
pub mod errors;
/// IO traits
pub mod io;
/// Lockfile implementation
pub mod lock;
/// Log subscriber implementation
pub mod logs;
/// Manifest format and IO
pub mod manifest;
/// Dedicated helpers to deal with more complicated CLI operations
pub mod operations;
/// Packages formats and utilities
pub mod package;
/// Supported registries
pub mod registry;
/// Resolve package dependencies
pub mod resolver;
/// Validation for buffrs packages.
#[cfg(feature = "validation")]
pub mod validation;
/// Workspace related business logic.
pub mod workspace;

/// Managed directory for `buffrs`
pub const BUFFRS_HOME: &str = ".buffrs";

pub(crate) const BUFFRS_HOME_VAR: &str = "BUFFRS_HOME";

#[derive(Error, Diagnostic, Debug)]
#[error("could not determine buffrs home location")]
struct HomeError(#[diagnostic_source] miette::Report);

fn home() -> Result<PathBuf, HomeError> {
    env::var(BUFFRS_HOME_VAR)
        .map(PathBuf::from)
        .or_else(|_| {
            home::home_dir()
                .ok_or_else(|| miette::miette!("{BUFFRS_HOME_VAR} is not set and the user's home folder could not be determined"))
        })
        .map(|home| home.join(BUFFRS_HOME))
        .map_err(HomeError)
}

#[derive(Debug)]
pub(crate) enum ManagedFile {
    Credentials,
    Manifest,
    Lock,
}

impl ManagedFile {
    fn name(&self) -> &str {
        use credentials::CREDENTIALS_FILE;
        use lock::LOCKFILE;
        use manifest::MANIFEST_FILE;

        match self {
            ManagedFile::Manifest => MANIFEST_FILE,
            ManagedFile::Lock => LOCKFILE,
            ManagedFile::Credentials => CREDENTIALS_FILE,
        }
    }
}

impl std::fmt::Display for ManagedFile {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.name())
    }
}