Struct libblkid_rs::BlkidProbe

pub struct BlkidProbe(_);

A structure for probing block devices.

Implementations

impl BlkidProbe

pub fn new() -> Result<Self>

Allocate and create a new libblkid probe.

pub fn new_from_filename(filename: &Path) -> Result<Self>

Create a new probe from a filename.

pub fn reset(&mut self)

Reset the probe.

pub fn reset_buffers(&mut self) -> Result<()>

Reset and free all buffers used in the probe.

pub fn hide_range(&mut self, offset: u64, len: u64) -> Result<()>

Hide a memory range in the probe from the next do_probe call.

pub fn set_device(
    &mut self,
    fd: RawFd,
    offset: blkid_loff_t,
    size: blkid_loff_t
) -> Result<()>

Assign the device to the probe control structure.

pub fn get_devno(&self) -> BlkidDevno

Get the device number associated with the probe device.

pub fn get_wholedisk_devno(&self) -> BlkidDevno

Get the device number of the whole disk

pub fn is_wholedisk(&self) -> bool

Check if the given device is an entire disk (instead of a partition or something similar)

pub fn get_size(&self) -> blkid_loff_t

Get the size of of a device.

pub fn get_offset(&self) -> blkid_loff_t

Get the offset of a probing area of a device.

pub fn get_sector_size(&self) -> c_uint

Get the sector size of the attached device.

pub fn get_fd(&self) -> Result<RawFd>

Get a file descriptor associated with the given device.

pub fn enable_superblocks(&mut self, enable: bool) -> Result<()>

Enable superblock probing.

pub fn set_superblock_flags(&mut self, flags: BlkidSublksFlags) -> Result<()>

Set the superblock probing flags.

pub fn reset_superblock_filter(&mut self) -> Result<()>

Reset the superblock probing filter.

pub fn invert_superblock_filter(&mut self) -> Result<()>

Invert the superblock probing filter.

pub fn filter_superblock_type(
    &mut self,
    flag: BlkidFltr,
    names: &[&str]
) -> Result<()>

Filter superblock types based on the provided flags and name.

pub fn filter_superblock_usage(
    &mut self,
    flag: BlkidFltr,
    usage: BlkidUsageFlags
) -> Result<()>

Filter devices based on the usages specified in the usage parameter.

pub fn enable_topology(&mut self, enable: bool) -> Result<()>

Enable topology probing.

pub fn get_topology(&mut self) -> Result<BlkidTopology>

Get the blkid topology of devices.

The topology will be overwritten with each call to this method per the libblkid documentation. To use multiple topologies simultaneously, you must use multiple BlkidProbe structs.

pub fn enable_partitions(&mut self, enable: bool) -> Result<()>

Enable partition probing.

pub fn reset_partition_filter(&mut self) -> Result<()>

Reset the partition filter.

pub fn invert_partition_filter(&mut self) -> Result<()>

Invert the partition filter.

pub fn filter_partition_types(
    &mut self,
    flag: BlkidFltr,
    names: &[&str]
) -> Result<()>

Probe for partitions using the specified partition types.

This method can either probe for partitions with partition types specified in names or only for partition types not found in names.

pub fn get_partitions(&mut self) -> Result<BlkidPartlist>

Get list of probed partitions.

pub fn do_probe(&mut self) -> Result<BlkidProbeRet>

Probe for signatures at the tag level (TAG=VALUE). Superblocks will be probed by default. This method calls only one function call at a time and should be called in a loop to get results from all probing chains.

pub fn do_safeprobe(&mut self) -> Result<BlkidSafeprobeRet>

Probes all enabled chains and checks for ambiguous results.

pub fn do_fullprobe(&mut self) -> Result<BlkidFullprobeRet>

Same as do_safeprobe but does not check for collisions.

pub fn numof_values(&self) -> Result<usize>

Number of values in probe

pub fn get_value(&self, num: c_uint) -> Result<(String, String)>

Get the tag and value of an entry by the index in the range 0..(self.numof_values()).

pub fn lookup_value(&self, name: &str) -> Result<String>

Get the value for a tag with the given name.

pub fn has_value(&self, name: &str) -> Result<bool>

Check whether the given name exists in a probe.

pub fn do_wipe(&mut self, dry_run: bool) -> Result<()>

Wipe the current probed block signature.

pub fn step_back(&mut self) -> Result<()>

Set the probing on step back on the probing chain.

pub fn set_request(&mut self, flags: BlkidProbreqFlags) -> Result<()>

Set request flags.

Trait Implementations

impl Drop for BlkidProbe

fn drop(&mut self)

Executes the destructor for this type.