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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
use std::{
cell::{RefCell, RefMut},
collections::HashSet,
fmt::{self, Display, Formatter},
io::{Cursor, Read, Seek},
};
use crate::{
codetables::{
CodeTable3_1, CodeTable4_0, CodeTable4_1, CodeTable4_2, CodeTable4_3, CodeTable5_0, Lookup,
},
datatypes::*,
error::*,
grid::GridPointIterator,
parser::Grib2SubmessageIndexStream,
reader::{Grib2Read, Grib2SectionStream, SeekableGrib2Reader, SECT8_ES_SIZE},
GridPointIndexIterator,
};
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct SectionInfo {
pub num: u8,
pub offset: usize,
pub size: usize,
pub body: Option<SectionBody>,
}
impl SectionInfo {
pub fn get_tmpl_code(&self) -> Option<TemplateInfo> {
let tmpl_num = self.body.as_ref()?.get_tmpl_num()?;
Some(TemplateInfo(self.num, tmpl_num))
}
pub(crate) fn new_8(offset: usize) -> Self {
Self {
num: 8,
offset,
size: SECT8_ES_SIZE,
body: None,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SectionBody {
Section0(Indicator),
Section1(Identification),
Section2(LocalUse),
Section3(GridDefinition),
Section4(ProdDefinition),
Section5(ReprDefinition),
Section6(BitMap),
Section7,
}
impl SectionBody {
fn get_tmpl_num(&self) -> Option<u16> {
match self {
Self::Section3(s) => Some(s.grid_tmpl_num()),
Self::Section4(s) => Some(s.prod_tmpl_num()),
Self::Section5(s) => Some(s.repr_tmpl_num()),
_ => None,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct TemplateInfo(pub u8, pub u16);
impl TemplateInfo {
pub fn describe(&self) -> Option<String> {
match self.0 {
3 => Some(CodeTable3_1.lookup(usize::from(self.1)).to_string()),
4 => Some(CodeTable4_0.lookup(usize::from(self.1)).to_string()),
5 => Some(CodeTable5_0.lookup(usize::from(self.1)).to_string()),
_ => None,
}
}
}
impl Display for TemplateInfo {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(f, "{}.{}", self.0, self.1)
}
}
/// Reads a [`Grib2`] instance from an I/O stream of GRIB2.
///
/// # Examples
///
/// ```
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let f = std::fs::File::open(
/// "testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
/// )?;
/// let f = std::io::BufReader::new(f);
/// let result = grib::from_reader(f);
///
/// assert!(result.is_ok());
/// let grib2 = result?;
/// assert_eq!(grib2.len(), 1);
/// Ok(())
/// }
/// ```
pub fn from_reader<SR: Read + Seek>(
reader: SR,
) -> Result<Grib2<SeekableGrib2Reader<SR>>, GribError> {
Grib2::<SeekableGrib2Reader<SR>>::read_with_seekable(reader)
}
/// Reads a [`Grib2`] instance from bytes of GRIB2.
///
/// # Examples
///
/// ```
/// use std::io::Read;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let f = std::fs::File::open(
/// "testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
/// )?;
/// let mut f = std::io::BufReader::new(f);
/// let mut buf = Vec::new();
/// f.read_to_end(&mut buf).unwrap();
/// let result = grib::from_slice(&buf);
///
/// assert!(result.is_ok());
/// let grib2 = result?;
/// assert_eq!(grib2.len(), 1);
/// Ok(())
/// }
/// ```
pub fn from_slice(bytes: &[u8]) -> Result<Grib2<SeekableGrib2Reader<Cursor<&[u8]>>>, GribError> {
let reader = Cursor::new(bytes);
Grib2::<SeekableGrib2Reader<Cursor<&[u8]>>>::read_with_seekable(reader)
}
pub struct Grib2<R> {
reader: RefCell<R>,
sections: Box<[SectionInfo]>,
submessages: Vec<Grib2SubmessageIndex>,
}
impl<R> Grib2<R> {
/// Returns the length of submessages in the data.
///
/// # Examples
///
/// ```
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let f = std::fs::File::open(
/// "testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
/// )?;
/// let f = std::io::BufReader::new(f);
/// let grib2 = grib::from_reader(f)?;
///
/// assert_eq!(grib2.len(), 1);
/// Ok(())
/// }
/// ```
pub fn len(&self) -> usize {
self.submessages.len()
}
/// Returns `true` if `self` has zero submessages.
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// Returns an iterator over submessages in the data.
///
/// # Examples
///
/// ```
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let f = std::fs::File::open(
/// "testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
/// )?;
/// let f = std::io::BufReader::new(f);
/// let grib2 = grib::from_reader(f)?;
///
/// let mut iter = grib2.iter();
/// let first = iter.next();
/// assert!(first.is_some());
///
/// let first = first.unwrap();
/// let (message_index, _) = first;
/// assert_eq!(message_index, (0, 0));
///
/// let second = iter.next();
/// assert!(second.is_none());
/// Ok(())
/// }
/// ```
#[inline]
pub fn iter(&self) -> SubmessageIterator<R> {
self.into_iter()
}
/// Returns an iterator over submessages in the data.
///
/// This is an alias to [`Grib2::iter()`].
pub fn submessages(&self) -> SubmessageIterator<R> {
self.into_iter()
}
/// Returns an iterator over sections in the data.
///
/// # Examples
///
/// ```
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let f = std::fs::File::open(
/// "testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
/// )?;
/// let f = std::io::BufReader::new(f);
/// let grib2 = grib::from_reader(f)?;
///
/// let mut iter = grib2.sections();
/// let first = iter.next();
/// assert!(first.is_some());
///
/// let first = first.unwrap();
/// assert_eq!(first.num, 0);
///
/// let tenth = iter.nth(9);
/// assert!(tenth.is_none());
/// Ok(())
/// }
/// ```
pub fn sections(&self) -> std::slice::Iter<SectionInfo> {
self.sections.iter()
}
}
impl<R: Grib2Read> Grib2<R> {
pub fn read(r: R) -> Result<Self, GribError> {
let mut sect_stream = Grib2SectionStream::new(r);
let mut cacher = Vec::new();
let parser = Grib2SubmessageIndexStream::new(sect_stream.by_ref()).with_cacher(&mut cacher);
let submessages = parser.collect::<Result<Vec<_>, _>>()?;
Ok(Self {
reader: RefCell::new(sect_stream.into_reader()),
sections: cacher.into_boxed_slice(),
submessages,
})
}
pub fn read_with_seekable<SR: Read + Seek>(
r: SR,
) -> Result<Grib2<SeekableGrib2Reader<SR>>, GribError> {
let r = SeekableGrib2Reader::new(r);
Grib2::<SeekableGrib2Reader<SR>>::read(r)
}
pub fn list_templates(&self) -> Vec<TemplateInfo> {
get_templates(&self.sections)
}
}
impl<'a, R: 'a> IntoIterator for &'a Grib2<R> {
type Item = (MessageIndex, SubMessage<'a, R>);
type IntoIter = SubmessageIterator<'a, R>;
fn into_iter(self) -> Self::IntoIter {
Self::IntoIter::new(self)
}
}
fn get_templates(sects: &[SectionInfo]) -> Vec<TemplateInfo> {
let uniq: HashSet<_> = sects.iter().filter_map(|s| s.get_tmpl_code()).collect();
let mut vec: Vec<_> = uniq.into_iter().collect();
vec.sort_unstable();
vec
}
/// An iterator over submessages in the GRIB data.
///
/// This `struct` is created by the [`iter`] method on [`Grib2`]. See its
/// documentation for more.
///
/// [`iter`]: Grib2::iter
#[derive(Clone)]
pub struct SubmessageIterator<'a, R> {
context: &'a Grib2<R>,
pos: usize,
}
impl<'a, R> SubmessageIterator<'a, R> {
fn new(context: &'a Grib2<R>) -> Self {
Self { context, pos: 0 }
}
fn new_submessage_section(&self, index: usize) -> Option<SubMessageSection<'a>> {
Some(SubMessageSection::new(
index,
self.context.sections.get(index)?,
))
}
}
impl<'a, R> Iterator for SubmessageIterator<'a, R> {
type Item = (MessageIndex, SubMessage<'a, R>);
fn next(&mut self) -> Option<Self::Item> {
let submessage_index = self.context.submessages.get(self.pos)?;
self.pos += 1;
Some((
submessage_index.message_index(),
SubMessage(
self.new_submessage_section(submessage_index.0)?,
self.new_submessage_section(submessage_index.1)?,
submessage_index
.2
.and_then(|i| self.new_submessage_section(i)),
self.new_submessage_section(submessage_index.3)?,
self.new_submessage_section(submessage_index.4)?,
self.new_submessage_section(submessage_index.5)?,
self.new_submessage_section(submessage_index.6)?,
self.new_submessage_section(submessage_index.7)?,
self.new_submessage_section(submessage_index.8)?,
self.context.reader.borrow_mut(),
),
))
}
fn size_hint(&self) -> (usize, Option<usize>) {
let size = self.context.submessages.len() - self.pos;
(size, Some(size))
}
fn nth(&mut self, n: usize) -> Option<Self::Item> {
self.pos = n;
self.next()
}
}
impl<'a, R> IntoIterator for &'a SubmessageIterator<'a, R> {
type Item = (MessageIndex, SubMessage<'a, R>);
type IntoIter = SubmessageIterator<'a, R>;
fn into_iter(self) -> Self::IntoIter {
SubmessageIterator {
context: self.context,
pos: self.pos,
}
}
}
pub struct SubMessage<'a, R>(
pub SubMessageSection<'a>,
pub SubMessageSection<'a>,
pub Option<SubMessageSection<'a>>,
pub SubMessageSection<'a>,
pub SubMessageSection<'a>,
pub SubMessageSection<'a>,
pub SubMessageSection<'a>,
pub SubMessageSection<'a>,
pub SubMessageSection<'a>,
pub(crate) RefMut<'a, R>,
);
impl<R> SubMessage<'_, R> {
/// Returns the product's parameter.
///
/// In the context of GRIB products, parameters refer to weather elements
/// such as air temperature, air pressure, and humidity, and other physical
/// quantities.
///
/// # Examples
///
/// ```
/// use std::{
/// fs::File,
/// io::{BufReader, Read},
/// };
///
/// use grib::codetables::NCEP;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut buf = Vec::new();
///
/// let f = File::open("testdata/gdas.t12z.pgrb2.0p25.f000.0-10.xz")?;
/// let f = BufReader::new(f);
/// let mut f = xz2::bufread::XzDecoder::new(f);
/// f.read_to_end(&mut buf)?;
///
/// let f = std::io::Cursor::new(buf);
/// let grib2 = grib::from_reader(f)?;
///
/// let mut iter = grib2.iter();
/// let (_, message) = iter.next().ok_or_else(|| "first message is not found")?;
///
/// let param = message.parameter();
/// assert_eq!(
/// param,
/// Some(grib::Parameter {
/// discipline: 0,
/// centre: 7,
/// master_ver: 2,
/// local_ver: 1,
/// category: 3,
/// num: 1
/// })
/// );
/// let param = param.unwrap();
/// assert_eq!(
/// param.description(),
/// Some("Pressure reduced to MSL".to_owned())
/// );
/// assert!(param.is_identical_to(NCEP::PRMSL));
/// Ok(())
/// }
/// ```
pub fn parameter(&self) -> Option<Parameter> {
let discipline = self.indicator().discipline;
let ident = self.identification();
let centre = ident.centre_id();
let master_ver = ident.master_table_version();
let local_ver = ident.local_table_version();
let prod_def = self.prod_def();
let category = prod_def.parameter_category()?;
let num = prod_def.parameter_number()?;
Some(Parameter {
discipline,
centre,
master_ver,
local_ver,
category,
num,
})
}
pub fn indicator(&self) -> &Indicator {
// panics should not happen if data is correct
match self.0.body.body.as_ref().unwrap() {
SectionBody::Section0(data) => data,
_ => panic!("something unexpected happened"),
}
}
fn identification(&self) -> &Identification {
// panics should not happen if data is correct
match self.1.body.body.as_ref().unwrap() {
SectionBody::Section1(data) => data,
_ => panic!("something unexpected happened"),
}
}
pub fn grid_def(&self) -> &GridDefinition {
// panics should not happen if data is correct
match self.3.body.body.as_ref().unwrap() {
SectionBody::Section3(data) => data,
_ => panic!("something unexpected happened"),
}
}
pub fn prod_def(&self) -> &ProdDefinition {
// panics should not happen if data is correct
match self.4.body.body.as_ref().unwrap() {
SectionBody::Section4(data) => data,
_ => panic!("something unexpected happened"),
}
}
pub fn repr_def(&self) -> &ReprDefinition {
// panics should not happen if data is correct
match self.5.body.body.as_ref().unwrap() {
SectionBody::Section5(data) => data,
_ => panic!("something unexpected happened"),
}
}
pub fn describe(&self) -> String {
let category = self.prod_def().parameter_category();
let forecast_time = self
.prod_def()
.forecast_time()
.map(|ft| ft.describe())
.unwrap_or((String::new(), String::new()));
let fixed_surfaces_info = self
.prod_def()
.fixed_surfaces()
.map(|(first, second)| (first.describe(), second.describe()))
.map(|(first, second)| (first.0, first.1, first.2, second.0, second.1, second.2))
.unwrap_or((
String::new(),
String::new(),
String::new(),
String::new(),
String::new(),
String::new(),
));
format!(
"\
Grid: {}
Number of points: {}
Product: {}
Parameter Category: {}
Parameter: {}
Generating Proceess: {}
Forecast Time: {}
Forecast Time Unit: {}
1st Fixed Surface Type: {}
1st Scale Factor: {}
1st Scaled Value: {}
2nd Fixed Surface Type: {}
2nd Scale Factor: {}
2nd Scaled Value: {}
Data Representation: {}
Number of represented values: {}
",
self.3.describe().unwrap_or_default(),
self.grid_def().num_points(),
self.4.describe().unwrap_or_default(),
category
.map(|v| CodeTable4_1::new(self.indicator().discipline)
.lookup(usize::from(v))
.to_string())
.unwrap_or_default(),
self.prod_def()
.parameter_number()
.zip(category)
.map(|(n, c)| CodeTable4_2::new(self.indicator().discipline, c)
.lookup(usize::from(n))
.to_string())
.unwrap_or_default(),
self.prod_def()
.generating_process()
.map(|v| CodeTable4_3.lookup(usize::from(v)).to_string())
.unwrap_or_default(),
forecast_time.1,
forecast_time.0,
fixed_surfaces_info.0,
fixed_surfaces_info.1,
fixed_surfaces_info.2,
fixed_surfaces_info.3,
fixed_surfaces_info.4,
fixed_surfaces_info.5,
self.5.describe().unwrap_or_default(),
self.repr_def().num_points(),
)
}
/// Returns the shape of the grid, i.e. a tuple of the number of grids in
/// the i and j directions.
///
/// # Examples
///
/// ```
/// use std::{
/// fs::File,
/// io::{BufReader, Read},
/// };
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut buf = Vec::new();
///
/// let f = File::open("testdata/gdas.t12z.pgrb2.0p25.f000.0-10.xz")?;
/// let f = BufReader::new(f);
/// let mut f = xz2::bufread::XzDecoder::new(f);
/// f.read_to_end(&mut buf)?;
///
/// let f = std::io::Cursor::new(buf);
/// let grib2 = grib::from_reader(f)?;
///
/// let mut iter = grib2.iter();
/// let (_, message) = iter.next().ok_or_else(|| "first message is not found")?;
///
/// let shape = message.grid_shape()?;
/// assert_eq!(shape, (1440, 721));
/// Ok(())
/// }
/// ```
pub fn grid_shape(&self) -> Result<(usize, usize), GribError> {
let grid_def = self.grid_def();
let shape = GridDefinitionTemplateValues::try_from(grid_def)?.grid_shape();
Ok(shape)
}
/// Computes and returns an iterator over `(i, j)` of grid points.
///
/// The order of items is the same as the order of the grid point values,
/// defined by the scanning mode ([`ScanningMode`](`crate::ScanningMode`))
/// in the data.
///
/// This iterator allows users to perform their own coordinate calculations
/// for unsupported grid systems and map the results to grid point values.
///
/// # Examples
///
/// ```
/// use std::{
/// fs::File,
/// io::{BufReader, Read},
/// };
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut buf = Vec::new();
///
/// let f = File::open("testdata/gdas.t12z.pgrb2.0p25.f000.0-10.xz")?;
/// let f = BufReader::new(f);
/// let mut f = xz2::bufread::XzDecoder::new(f);
/// f.read_to_end(&mut buf)?;
///
/// let f = std::io::Cursor::new(buf);
/// let grib2 = grib::from_reader(f)?;
///
/// let mut iter = grib2.iter();
/// let (_, message) = iter.next().ok_or_else(|| "first message is not found")?;
///
/// let mut latlons = message.ij()?;
/// assert_eq!(latlons.next(), Some((0, 0)));
/// assert_eq!(latlons.next(), Some((1, 0)));
/// Ok(())
/// }
/// ```
pub fn ij(&self) -> Result<GridPointIndexIterator, GribError> {
let grid_def = self.grid_def();
let num_defined = grid_def.num_points() as usize;
let ij = GridDefinitionTemplateValues::try_from(grid_def)?.ij()?;
let (num_decoded, _) = ij.size_hint();
if num_defined == num_decoded {
Ok(ij)
} else {
Err(GribError::InvalidValueError(format!(
"number of grid points does not match: {num_defined} (defined) vs {num_decoded} (decoded)"
)))
}
}
/// Computes and returns an iterator over latitudes and longitudes of grid
/// points.
///
/// The order of lat/lon data of grid points is the same as the order of the
/// grid point values, defined by the scanning mode
/// ([`ScanningMode`](`crate::ScanningMode`)) in the data.
///
/// # Examples
///
/// ```
/// use std::{
/// fs::File,
/// io::{BufReader, Read},
/// };
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let mut buf = Vec::new();
///
/// let f = File::open("testdata/gdas.t12z.pgrb2.0p25.f000.0-10.xz")?;
/// let f = BufReader::new(f);
/// let mut f = xz2::bufread::XzDecoder::new(f);
/// f.read_to_end(&mut buf)?;
///
/// let f = std::io::Cursor::new(buf);
/// let grib2 = grib::from_reader(f)?;
///
/// let mut iter = grib2.iter();
/// let (_, message) = iter.next().ok_or_else(|| "first message is not found")?;
///
/// let mut latlons = message.latlons()?;
/// assert_eq!(latlons.next(), Some((90.0, 0.0)));
/// assert_eq!(latlons.next(), Some((90.0, 0.25000003)));
/// Ok(())
/// }
/// ```
pub fn latlons(&self) -> Result<GridPointIterator, GribError> {
let grid_def = self.grid_def();
let num_defined = grid_def.num_points() as usize;
let latlons = GridDefinitionTemplateValues::try_from(grid_def)?.latlons()?;
let (num_decoded, _) = latlons.size_hint();
if num_defined == num_decoded {
Ok(latlons)
} else {
Err(GribError::InvalidValueError(format!(
"number of grid points does not match: {num_defined} (defined) vs {num_decoded} (decoded)"
)))
}
}
}
pub struct SubMessageSection<'a> {
pub index: usize,
pub body: &'a SectionInfo,
}
impl<'a> SubMessageSection<'a> {
pub fn new(index: usize, body: &'a SectionInfo) -> Self {
Self { index, body }
}
pub fn template_code(&self) -> Option<TemplateInfo> {
self.body.get_tmpl_code()
}
pub fn describe(&self) -> Option<String> {
self.template_code().and_then(|code| code.describe())
}
}
#[cfg(test)]
mod tests {
use std::{fs::File, io::BufReader};
use super::*;
macro_rules! sect_placeholder {
($num:expr) => {{
SectionInfo {
num: $num,
offset: 0,
size: 0,
body: None,
}
}};
}
#[test]
fn from_buf_reader() {
let f = File::open(
"testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
)
.unwrap();
let f = BufReader::new(f);
let result = from_reader(f);
assert!(result.is_ok())
}
#[test]
fn from_bytes() {
let f = File::open(
"testdata/icon_global_icosahedral_single-level_2021112018_000_TOT_PREC.grib2",
)
.unwrap();
let mut f = BufReader::new(f);
let mut buf = Vec::new();
f.read_to_end(&mut buf).unwrap();
let result = from_slice(&buf);
assert!(result.is_ok())
}
#[test]
fn get_tmpl_code_normal() {
let sect = SectionInfo {
num: 5,
offset: 8902,
size: 23,
body: Some(SectionBody::Section5(
ReprDefinition::from_payload(
vec![0x00, 0x01, 0x50, 0x00, 0x00, 0xc8].into_boxed_slice(),
)
.unwrap(),
)),
};
assert_eq!(sect.get_tmpl_code(), Some(TemplateInfo(5, 200)));
}
#[test]
fn get_templates_normal() {
let sects = vec![
sect_placeholder!(0),
sect_placeholder!(1),
SectionInfo {
num: 3,
offset: 0,
size: 0,
body: Some(SectionBody::Section3(
GridDefinition::from_payload(vec![0; 9].into_boxed_slice()).unwrap(),
)),
},
SectionInfo {
num: 4,
offset: 0,
size: 0,
body: Some(SectionBody::Section4(
ProdDefinition::from_payload(vec![0; 4].into_boxed_slice()).unwrap(),
)),
},
SectionInfo {
num: 5,
offset: 0,
size: 0,
body: Some(SectionBody::Section5(
ReprDefinition::from_payload(vec![0; 6].into_boxed_slice()).unwrap(),
)),
},
sect_placeholder!(6),
sect_placeholder!(7),
SectionInfo {
num: 3,
offset: 0,
size: 0,
body: Some(SectionBody::Section3(
GridDefinition::from_payload(
vec![0, 0, 0, 0, 0, 0, 0, 0, 1].into_boxed_slice(),
)
.unwrap(),
)),
},
SectionInfo {
num: 4,
offset: 0,
size: 0,
body: Some(SectionBody::Section4(
ProdDefinition::from_payload(vec![0; 4].into_boxed_slice()).unwrap(),
)),
},
SectionInfo {
num: 5,
offset: 0,
size: 0,
body: Some(SectionBody::Section5(
ReprDefinition::from_payload(vec![0; 6].into_boxed_slice()).unwrap(),
)),
},
sect_placeholder!(6),
sect_placeholder!(7),
sect_placeholder!(8),
]
.into_boxed_slice();
assert_eq!(
get_templates(§s),
vec![
TemplateInfo(3, 0),
TemplateInfo(3, 1),
TemplateInfo(4, 0),
TemplateInfo(5, 0),
]
);
}
macro_rules! test_submessage_iterator {
($((
$name:ident,
$xz_compressed_input:expr,
$nth:expr,
$expected_index:expr,
$expected_section_indices:expr,
),)*) => ($(
#[test]
fn $name() -> Result<(), Box<dyn std::error::Error>> {
let mut buf = Vec::new();
let f = File::open($xz_compressed_input)?;
let f = BufReader::new(f);
let mut f = xz2::bufread::XzDecoder::new(f);
f.read_to_end(&mut buf)?;
let f = Cursor::new(buf);
let grib2 = crate::from_reader(f)?;
let mut iter = grib2.iter();
let (actual_index, message) = iter.nth($nth).ok_or_else(|| "item not available")?;
assert_eq!(actual_index, $expected_index);
let actual_section_indices = get_section_indices(message);
assert_eq!(actual_section_indices, $expected_section_indices);
Ok(())
}
)*);
}
test_submessage_iterator! {
(
item_0_from_submessage_iterator_for_single_message_data_with_multiple_submessages,
"testdata/Z__C_RJTD_20190304000000_MSM_GUID_Rjp_P-all_FH03-39_Toorg_grib2.bin.xz",
0,
(0, 0),
(0, 1, None, 2, 3, 4, 5, 6, 0),
),
(
item_1_from_submessage_iterator_for_single_message_data_with_multiple_submessages,
"testdata/Z__C_RJTD_20190304000000_MSM_GUID_Rjp_P-all_FH03-39_Toorg_grib2.bin.xz",
1,
(0, 1),
(0, 1, None, 2, 7, 8, 9, 10, 0),
),
(
item_0_from_submessage_iterator_for_multi_message_data,
"testdata/gdas.t12z.pgrb2.0p25.f000.0-10.xz",
0,
(0, 0),
(0, 1, None, 2, 3, 4, 5, 6, 7),
),
(
item_1_from_submessage_iterator_for_multi_message_data,
"testdata/gdas.t12z.pgrb2.0p25.f000.0-10.xz",
1,
(1, 0),
(8, 9, None, 10, 11, 12, 13, 14, 15),
),
}
fn get_section_indices<R>(
submessage: SubMessage<'_, R>,
) -> (
usize,
usize,
Option<usize>,
usize,
usize,
usize,
usize,
usize,
usize,
) {
(
submessage.0.index,
submessage.1.index,
submessage.2.map(|s| s.index),
submessage.3.index,
submessage.4.index,
submessage.5.index,
submessage.6.index,
submessage.7.index,
submessage.8.index,
)
}
}