nuts_tool/cli/container/read.rs
1// MIT License
2//
3// Copyright (c) 2023,2024 Robin Doer
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to
7// deal in the Software without restriction, including without limitation the
8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22
23use anyhow::Result;
24use clap::Args;
25use log::debug;
26use std::cmp;
27
28use crate::cli::open_container;
29use crate::format::Format;
30use crate::say::is_quiet;
31
32#[derive(Args, Debug)]
33pub struct ContainerReadArgs {
34 /// The id of the block to read
35 id: String,
36
37 /// Specifies the format of the userdata dump
38 #[clap(short, long, value_parser, default_value = "raw")]
39 format: Format,
40
41 /// Reads up to SIZE bytes. If not specified, reads the whole block
42 #[clap(short, long, id = "SIZE")]
43 max_bytes: Option<u64>,
44
45 /// Specifies the name of the container
46 #[clap(short, long, env = "NUTS_CONTAINER")]
47 container: String,
48}
49
50impl ContainerReadArgs {
51 pub fn run(&self) -> Result<()> {
52 debug!("args: {:?}", self);
53
54 let mut container = open_container(&self.container)?;
55 let id = self.id.parse()?;
56
57 let max_bytes = self.max_bytes.unwrap_or(u64::MAX);
58 let block_size = container.block_size();
59 let max_bytes = cmp::min(max_bytes, block_size as u64) as usize;
60
61 debug!("block_size: {} => max_bytes: {}", block_size, max_bytes);
62
63 let mut buf = vec![0; max_bytes];
64 let mut writer = self.format.create_writer();
65
66 let n = container.read(&id, &mut buf)?;
67
68 if !is_quiet() {
69 writer.print(&buf[..n])?;
70 writer.flush()?;
71 }
72
73 Ok(())
74 }
75}