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
//! Pull parser for FBX binary.
//!
//! # FBX versions and types
//!
//! Some types are version-agnostic, and some aren't.
//!
//! These modules are common among all supported FBX versions:
//!
//! * Error types (defined in [`error`] module).
//! * [`AnyParser`][`any::AnyParser`] feature (defined in [`any`] module).
//!
//! # Using pull parser
//!
//! There are two ways to set up a parser: easy setup and manual setup.
//!
//! ## Easy setup (recommended)
//!
//! If you don't care about precise FBX version (e.g. difference between FBX 7.4
//! and 7.5), you can use easy setup using [`any`] module.
//!
//! ```no_run
//! use fbxcel::pull_parser::any::AnyParser;
//!
//! let file = std::fs::File::open("sample.fbx").expect("Failed to open file");
//! // You can also use raw `file`, but do buffering for better efficiency.
//! let reader = std::io::BufReader::new(file);
//!
//! // Use `AnyParser::from_seekable_reader` for readers implementing
//! // `std::io::Seek`. To use readers without `std::io::Seek` implementation,
//! // use `AnyPraser::from_reader` instead.
//! match AnyParser::from_seekable_reader(reader).expect("Failed to setup FBX parser") {
//! // Use v7400 parser (implemented in `v7400` module).
//! AnyParser::V7400(mut parser) => {
//! // You got a parser! Do what you want!
//! },
//! // `AnyParser` is nonexhaustive.
//! // You should handle new unknown parser version case.
//! _ => panic!("Unsupported FBX parser is required"),
//! }
//! ```
//!
//! ## Manual setup
//!
//! In this way you have full control, but usual users don't need this.
//!
//! 1. Get FBX header.
//! 2. Decide which version of parser to use.
//! 3. Create parser with source reader.
//!
//! ```no_run
//! use fbxcel::{low::FbxHeader, pull_parser::ParserVersion};
//!
//! let file = std::fs::File::open("sample.fbx").expect("Failed to open file");
//! // You can also use raw `file`, but do buffering for better efficiency.
//! let mut reader = std::io::BufReader::new(file);
//!
//! // 1. Get FBX header.
//! let header = FbxHeader::load(&mut reader)
//! .expect("Failed to load FBX header");
//! // 2. Decide which version of parser to use.
//! match header.parser_version() {
//! // Use v7400 parser (implemented in `v7400` module).
//! Some(ParserVersion::V7400) => {
//! // 3. Create parser with source reader.
//! // Pass both header and reader.
//! // Use `Parser::from_seekable_reader` for readers implementing
//! // `std::io::Seek`. To use readers without `std::io::Seek`
//! // implementation, use `Parser::from_reader` instead.
//! let mut parser = fbxcel::pull_parser::v7400::Parser::from_seekable_reader(header, reader)
//! .expect("Failed to setup parser");
//! // You got a parser! Do what you want!
//! },
//! // `ParserVersion` is nonexhaustive.
//! // You should handle new unknown parser version case.
//! Some(v) => panic!("Parser version {:?} is not yet supported", v),
//! // No appropriate parser found
//! None => panic!(
//! "FBX version {:?} is not supported by backend library",
//! header.version()
//! ),
//! }
//! ```
pub use ;