linux-support 0.0.25

Comprehensive Linux support for namespaces, cgroups, processes, scheduling, parsing /proc, parsing /sys, signals, hyper threads, CPUS, NUMA nodes, unusual file descriptors, PCI devices and much, much more
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
99
100
101
102
103
104
105
106
107
108
109
110
111

// This file is part of linux-support. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT. No part of linux-support, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2020 The developers of linux-support. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT.


/// File system metadata.
#[derive(Debug, Clone)]
pub struct FileSystemMetadata(pub(crate) statvfs);

impl FileSystemMetadata
{
	/// Block size.
	///
	/// Except for NFS, the same as `filesystem_fragment_block_size()`.
	/// Equivalent to `Metadata::filesystem_block_size()` and `ExtendedMetadata::filesystem_block_size()`.
	#[inline(always)]
	pub fn filesystem_preferred_block_size(&self) -> u64
	{
		self.0.f_bsize
	}

	/// Block size.
	///
	/// Except for NFS, the same as `filesystem_preferred_block_size()`.
	#[inline(always)]
	pub fn filesystem_fragment_block_size(&self) -> u64
	{
		self.0.f_frsize
	}

	/// Multiply by `filesystem_fragment_block_size()` for number of bytes.
	///
	/// Should be equal to or greater than `number_of_free_blocks()` and `number_of_free_blocks_for_unprivileged_users()`.
	#[inline(always)]
	pub fn number_of_blocks(&self) -> u64
	{
		self.0.f_blocks
	}

	/// Multiply by `filesystem_fragment_block_size()` for number of bytes.
	///
	/// Should be equal to or less than `number_of_blocks()`.
	/// Should be equal to or greater than `number_of_free_blocks_for_unprivileged_users()`.
	#[inline(always)]
	pub fn number_of_free_blocks(&self) -> u64
	{
		self.0.f_bfree
	}

	/// Multiply by `filesystem_fragment_block_size()` for number of bytes.
	///
	/// Should be equal to or less than `number_of_inodes()`.
	/// Should be equal to or less than `number_of_free_blocks()`.
	#[inline(always)]
	pub fn number_of_free_blocks_for_unprivileged_users(&self) -> u64
	{
		self.0.f_bavail
	}

	/// Should be equal to or greater than `number_of_free_inodes()` and `number_of_free_inodes_for_unprivileged_users()`.
	#[inline(always)]
	pub fn number_of_inodes(&self) -> NumberOfInodes
	{
		NumberOfInodes(self.0.f_files as usize)
	}

	/// Should be equal to or less than `number_of_inodes()`.
	/// Should be equal to or greater than `number_of_free_inodes()`.
	#[inline(always)]
	pub fn number_of_free_inodes(&self) -> NumberOfInodes
	{
		NumberOfInodes(self.0.f_ffree as usize)
	}

	/// Should be equal to or less than `number_of_inodes()`.
	/// Should be equal to or less than `number_of_free_inodes()`.
	#[inline(always)]
	pub fn number_of_free_inodes_for_unprivileged_users(&self) -> NumberOfInodes
	{
		NumberOfInodes(self.0.f_favail as usize)
	}

	/// ?
	#[inline(always)]
	pub fn file_system_identifier(&self) -> u64
	{
		self.0.f_fsid
	}

	#[allow(missing_docs)]
	#[inline(always)]
	pub fn maximum_file_name_length(&self) -> u64
	{
		self.0.f_namemax
	}

	/// Does not return invalid flags.
	#[inline(always)]
	pub fn mount_flags(&self) -> Option<FileSystemMountFlags>
	{
		let flags = self.0.f_flag;

		if likely!(flags & ST_VALID != 0)
		{
			Some(FileSystemMountFlags::from_bits_truncate(flags))
		}
		else
		{
			None
		}
	}
}