ironworks 0.4.1

Modular FFXIV data toolkit written in rust.
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

use crate::{error::Result, excel::metadata::SheetMetadata};

use super::sheet::Sheet;

/// Options used when reading a row from a sheet.
#[derive(Debug)]
pub struct RowOptions<'s, S> {
	sheet: Option<&'s Sheet<'s, S>>,
	pub(super) language: Option<u8>,
}

impl<'s, S: SheetMetadata> RowOptions<'s, S> {
	pub(super) fn new(sheet: &'s Sheet<S>) -> Self {
		Self {
			sheet: Some(sheet),
			language: None,
		}
	}

	/// Set the language to fetch.
	pub fn language(&mut self, language: impl Into<u8>) -> &mut Self {
		self.language = Some(language.into());
		self
	}

	/// Fetch a row from the sheet by ID. If the sheet supports subrows, this will
	/// return subrow 0.
	pub fn row(&self, row_id: u32) -> Result<S::Row> {
		self.sheet().row_with_options(row_id, self)
	}

	/// Fetch a subrow from the sheet by ID.
	pub fn subrow(&self, row_id: u32, subrow_id: u16) -> Result<S::Row> {
		self.sheet().subrow_with_options(row_id, subrow_id, self)
	}

	fn sheet(&self) -> &Sheet<'s, S> {
		self.sheet
			.expect("RowOptions created outside a sheet must be passed to a sheet manually.")
	}
}

impl<S> Default for RowOptions<'_, S> {
	fn default() -> Self {
		Self {
			sheet: None,
			language: None,
		}
	}
}