nitf-rs 0.3.1

Minimal NITF interface.
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

//! Header metadata definitions

use std::io::{Read, Seek, Write};

pub mod data_extension_hdr;
pub mod file_hdr;
pub mod graphic_hdr;
pub mod image_hdr;
pub mod reserved_extension_hdr;
pub mod text_hdr;

pub use data_extension_hdr::DataExtensionHeader;
pub use file_hdr::NitfHeader;
pub use graphic_hdr::GraphicHeader;
pub use image_hdr::ImageHeader;
pub use reserved_extension_hdr::ReservedExtensionHeader;
pub use text_hdr::TextHeader;

use crate::NitfResult;

/// Nitf segment header interface definition
///
/// Provide implementation for `read()`, `from_reader` defined automatically.
pub trait NitfSegmentHeader
where
    Self: Sized + Default + PartialEq + Eq + Ord + PartialOrd + Clone,
{
    /// Read the segment info from stream
    ///
    /// # Parameters
    ///
    /// reader: Stream from which to read header information
    #[allow(unused)]
    fn read(&mut self, reader: &mut (impl Read + Seek)) -> NitfResult<()>;

    /// Write the segment info to stream
    ///
    /// # Parameters
    ///
    /// writer: Stream from which to write header information
    #[allow(unused)]
    fn write(&self, writer: &mut (impl Write + Seek)) -> NitfResult<usize>;

    /// Get the length of the segment
    #[allow(unused)]
    fn length(&self) -> usize;

    fn from_reader(reader: &mut (impl Read + Seek)) -> NitfResult<Self> {
        let mut hdr = Self::default();
        hdr.read(reader)?;
        Ok(hdr)
    }
}