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
//! Import and export library for Visualization Toolkit (VTK) //! [files](https://lorensen.github.io/VTKExamples/site/VTKFileFormats/). //! //! Legacy `.vtk` files as well as modern XML formats are supported. //! Both "serial" and "parallel" XML files are supported with facilities for lazily loading. //! //! The [`Vtk`] struct exposes the primary IO API. //! //! # Examples //! //! Many sample files can be found in the `assets` directory. //! //! For the following example, we will load a VTK file named `tet.vtk`, modify it and write it back //! in Legacy ASCII format. //! //! ```no_run //! use vtkio::model::*; // import model definition of a VTK file //! fn main() { //! use std::path::PathBuf; //! let file_path = PathBuf::from("../assets/tet.vtk"); //! //! let mut vtk_file = Vtk::import(&file_path) //! .expect(&format!("Failed to load file: {:?}", file_path)); //! //! vtk_file.version = Version::new((4,2)); // arbitrary change //! //! vtk_file.export_ascii(&file_path) //! .expect(&format!("Failed to save file: {:?}", file_path)); //! } //! ``` //! //! Files are sometimes provided as strings or byte slices, so it is also useful to be able to //! parse VTK files and write them back to a string or byte slice. //! //! ```no_run //! use vtkio::model::*; // import model definition of a VTK file //! fn main() { //! let data: &[u8] = include_str!("../assets/tet.vtk").as_bytes(); // Or just include_bytes! //! //! let mut vtk_file = Vtk::parse_legacy_be(data).expect(&format!("Failed to parse file")); //! //! vtk_file.version = Version::new((4,2)); // arbitrary change //! //! let mut output = String::new(); //! Vtk::write_legacy_ascii(vtk_file, &mut output).expect(&format!("Failed to write file")); //! //! println!("{}", output); //! } //! ``` #[macro_use] extern crate nom; #[macro_use] pub mod basic; #[macro_use] pub mod model; pub mod parser; pub mod writer; #[cfg(feature = "xml")] pub mod xml; #[cfg(feature = "xml")] use std::convert::{TryFrom, TryInto}; use std::fs::File; #[cfg(feature = "xml")] use std::io::BufRead; use std::io::{self, BufWriter, Read, Write}; use std::path::Path; use crate::writer::{AsciiWriter, BinaryWriter, WriteVtk}; pub use model::IOBuffer; /// The primary `vtkio` API is provided through the `Vtk` struct. pub use model::Vtk; /// Error type for Import/Export operations. #[derive(Debug)] pub enum Error { IO(io::Error), Write(writer::Error), Parse(nom::ErrorKind<u32>), #[cfg(feature = "xml")] XML(xml::Error), UnknownFileExtension(Option<String>), Load(model::Error), Unknown, } impl std::fmt::Display for Error { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { match self { Error::IO(source) => write!(f, "IO error: {}", source), Error::Write(source) => write!(f, "Write error: {}", source), Error::Parse(source) => write!(f, "Parse error: {:?}", source), #[cfg(feature = "xml")] Error::XML(source) => write!(f, "XML error: {}", source), Error::UnknownFileExtension(Some(ext)) => { write!(f, "Unknown file extension: {:?}", ext) } Error::UnknownFileExtension(None) => write!(f, "Missing file extension"), Error::Load(source) => write!(f, "Load error: {}", source), Error::Unknown => write!(f, "Unknown error"), } } } impl std::error::Error for Error { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { Error::IO(source) => Some(source), Error::Write(source) => Some(source), Error::Parse(_) => None, #[cfg(feature = "xml")] Error::XML(source) => Some(source), Error::UnknownFileExtension(_) => None, Error::Load(source) => Some(source), Error::Unknown => None, } } } /// Convert `std::io` error into `vtkio` error. impl From<io::Error> for Error { fn from(e: io::Error) -> Error { Error::IO(e) } } /// Convert [`xml::Error`] error into the top level `vtkio` error. /// /// [`xml::Error`]: xml.enum.Error.html #[cfg(feature = "xml")] impl From<xml::Error> for Error { fn from(e: xml::Error) -> Error { Error::XML(e) } } /// Convert `vtkio` error into `std::io` error. impl From<Error> for io::Error { fn from(err: Error) -> io::Error { match err { Error::IO(e) => e, _ => io::Error::new(io::ErrorKind::Other, format!("{:?}", err)), } } } impl From<writer::Error> for Error { fn from(e: writer::Error) -> Error { Error::Write(e) } } impl Vtk { /// Helper for parsing legacy VTK files. fn parse_vtk<F>(mut reader: impl Read, parse: F, buf: &mut Vec<u8>) -> Result<Vtk, Error> where F: Fn(&[u8]) -> nom::IResult<&[u8], Vtk>, { use nom::IResult; reader.read_to_end(buf)?; match parse(buf) { IResult::Done(_, vtk) => Ok(vtk), IResult::Error(e) => Err(Error::Parse(e.into_error_kind())), IResult::Incomplete(_) => Err(Error::Unknown), } } /// Helper for importing legacy VTK files from the given path. fn import_vtk<F>(file_path: &Path, parse: F) -> Result<Vtk, Error> where F: Fn(&[u8]) -> nom::IResult<&[u8], Vtk>, { let file = File::open(file_path)?; Vtk::parse_vtk(file, parse, &mut Vec::new()) } /// Parse a legacy VTK file from the given reader. /// /// If the file is in binary format, numeric types will be interpreted in big endian format, /// which is the most common among VTK files. /// Note that this function and [`parse_legacy_le`](Vtk::parse_legacy_le) also work equally well for /// parsing VTK files in ASCII format. /// /// # Examples /// /// Parsing an ASCII file: /// /// ``` /// use vtkio::model::*; // import the model definition of a VTK file /// let vtk_ascii: &[u8] = b" /// ## vtk DataFile Version 2.0 /// Triangle example /// ASCII /// DATASET POLYDATA /// POINTS 3 float /// 0.0 0.0 0.0 /// 1.0 0.0 0.0 /// 0.0 0.0 -1.0 /// /// POLYGONS 1 4 /// 3 0 1 2 /// "; /// /// let vtk = Vtk::parse_legacy_be(vtk_ascii).expect("Failed to parse vtk file"); /// /// assert_eq!(vtk, Vtk { /// version: Version::new((2,0)), /// byte_order: ByteOrder::BigEndian, /// title: String::from("Triangle example"), /// file_path: None, /// data: DataSet::inline(PolyDataPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0].into(), /// polys: Some(VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![3, 0, 1, 2] /// }), /// data: Attributes::new(), /// ..Default::default() /// }) /// }); /// ``` pub fn parse_legacy_be(reader: impl Read) -> Result<Vtk, Error> { Vtk::parse_vtk(reader, parser::parse_be, &mut Vec::new()) } /// Parse a legacy VTK file from the given reader. /// /// If the file is in binary format, numeric types will be interpreted in little endian format. /// Note that this function and [`parse_legacy_be`](Vtk::parse_legacy_be) also work equally well for /// parsing VTK files in ASCII format. /// /// # Examples /// /// Parsing an ASCII file: /// /// ``` /// use vtkio::model::*; // import the model definition of a VTK file /// let vtk_ascii: &[u8] = b" /// ## vtk DataFile Version 2.0 /// Triangle example /// ASCII /// DATASET POLYDATA /// POINTS 3 float /// 0.0 0.0 0.0 /// 1.0 0.0 0.0 /// 0.0 0.0 -1.0 /// /// POLYGONS 1 4 /// 3 0 1 2 /// "; /// /// let vtk = Vtk::parse_legacy_le(vtk_ascii).expect("Failed to parse vtk file"); /// /// assert_eq!(vtk, Vtk { /// version: Version::new((2,0)), /// byte_order: ByteOrder::LittleEndian, /// title: String::from("Triangle example"), /// file_path: None, /// data: DataSet::inline(PolyDataPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0].into(), /// polys: Some(VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![3, 0, 1, 2] /// }), /// data: Attributes::new(), /// ..Default::default() /// }) /// }); /// ``` pub fn parse_legacy_le(reader: impl Read) -> Result<Vtk, Error> { Vtk::parse_vtk(reader, parser::parse_le, &mut Vec::new()) } /// Parse a legacy VTK file in big endian format from the given reader and a buffer. /// /// This is the buffered version of [`Vtk::parse_legacy_be`](Vtk::parse_legacy_be), which allows one to reuse the same /// heap allocated space when reading many files. pub fn parse_legacy_buf_be(reader: impl Read, buf: &mut Vec<u8>) -> Result<Vtk, Error> { Vtk::parse_vtk(reader, parser::parse_be, buf) } /// Parse a legacy VTK file in little endian format from the given reader and a buffer. /// /// This is the buffered version of [`parse_legacy_le`](Vtk::parse_legacy_le), which allows one to reuse the same /// heap allocated space when reading many files. pub fn parse_legacy_buf_le(reader: impl Read, buf: &mut Vec<u8>) -> Result<Vtk, Error> { Vtk::parse_vtk(reader, parser::parse_le, buf) } /// Parse a modern XML style VTK file from a given reader. /// /// # Examples /// /// Parsing a binary file in big endian format representing a polygon mesh consisting of a single /// triangle: /// /// ``` /// use vtkio::model::*; // import the model definition of a VTK file /// /// let input: &[u8] = b"\ /// <VTKFile type=\"PolyData\" version=\"2.0\" byte_order=\"BigEndian\">\ /// <PolyData>\ /// <Piece NumberOfPoints=\"3\" NumberOfLines=\"0\" NumberOfStrips=\"0\" NumberOfPolys=\"1\" NumberOfVerts=\"0\">\ /// <PointData/>\ /// <CellData/>\ /// <Points>\ /// <DataArray type=\"Float32\" format=\"binary\" NumberOfComponents=\"3\">\ /// AAAAAAAAAAQAAAAAAAAAAAAAAAA/gAAAAAAAAAAAAAAAAAAAAAAAAL+AAAA=\ /// </DataArray>\ /// </Points>\ /// <Polys>\ /// <DataArray type=\"UInt64\" Name=\"connectivity\" format=\"binary\" NumberOfComponents=\"1\">\ /// AAAAAAAAAAgAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAI=\ /// </DataArray>\ /// <DataArray type=\"UInt64\" Name=\"offsets\" format=\"binary\" NumberOfComponents=\"1\">\ /// AAAAAAAAAAgAAAAAAAAAAw==\ /// </DataArray>\ /// </Polys>\ /// </Piece>\ /// </PolyData>\ /// </VTKFile>"; /// /// let vtk = Vtk::parse_xml(input).expect("Failed to parse XML VTK file"); /// /// assert_eq!(vtk, Vtk { /// version: Version::new((2,0)), /// byte_order: ByteOrder::BigEndian, // This is default /// title: String::new(), /// file_path: None, /// data: DataSet::inline(PolyDataPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0].into(), /// polys: Some(VertexNumbers::XML { /// connectivity: vec![0, 1, 2], /// offsets: vec![3] /// }), /// data: Attributes::new(), /// ..Default::default() /// }) /// }); /// ``` #[cfg(feature = "xml")] pub fn parse_xml(reader: impl BufRead) -> Result<Vtk, Error> { // There is no extension to check with the data is provided directly. // Luckily the xml file contains all the data necessary to determine which data is // being parsed. let vtk_file = xml::parse(reader)?; Ok(vtk_file.try_into()?) } #[cfg(feature = "async_blocked")] async fn import_vtk_async<F>(file_path: &Path, parse: F) -> Result<Vtk, Error> where F: Fn(&[u8]) -> nom::IResult<&[u8], Vtk>, { use nom::IResult; use tokio::fs::File; use tokio::io::AsyncReadExt; let mut file = File::open(file_path).await?; let mut buf = Vec::new(); file.read_to_end(&mut buf).await?; match parse(&buf) { IResult::Done(_, vtk) => Ok(vtk), IResult::Error(e) => Err(Error::Parse(e.into_error_kind())), IResult::Incomplete(_) => Err(Error::Unknown), } } /// Import a VTK file at the specified path. /// /// This function determines the vtk file type from the extension as prescribed by the [VTK /// file formats documentation](https://lorensen.github.io/VTKExamples/site/VTKFileFormats/): /// /// - Legacy (`.vtk`) -- Simple legacy file format (Non-XML) /// - Image data (`.vti`) -- Serial vtkImageData (structured) /// - PolyData (`.vtp`) -- Serial vtkPolyData (unstructured) /// - RectilinearGrid (`.vtr`) -- Serial vtkRectilinearGrid (structured) /// - StructuredGrid (`.vts`) -- Serial vtkStructuredGrid (structured) /// - UnstructuredGrid (`.vtu`) -- Serial vtkUnstructuredGrid (unstructured) /// - PImageData (`.pvti`) -- Parallel vtkImageData (structured) /// - PPolyData (`.pvtp`) -- Parallel vtkPolyData (unstructured) /// - PRectilinearGrid (`.pvtr`) -- Parallel vtkRectilinearGrid (structured) /// - PStructuredGrid (`.pvts`) -- Parallel vtkStructuredGrid (structured) /// - PUnstructuredGrid (`.pvtu`) -- Parallel vtkUnstructuredGrid (unstructured) /// /// # Examples /// /// The following example imports a legacy `.vtk` file called `tet.vtk`, and panics with an /// appropriate error message if the file fails to load. /// /// ```should_panic /// use vtkio::Vtk; /// use std::path::PathBuf; /// /// let file_path = PathBuf::from("tet.vtk"); /// /// let mut vtk_file = Vtk::import(&file_path) /// .expect(&format!("Failed to load file: {:?}", file_path)); /// ``` pub fn import(file_path: impl AsRef<Path>) -> Result<Vtk, Error> { Vtk::import_impl(file_path.as_ref()) } /// A non-generic helper for the `import` function. fn import_impl(path: &Path) -> Result<Vtk, Error> { let ext = path .extension() .and_then(|s| s.to_str()) .ok_or(Error::UnknownFileExtension(None))?; match ext { "vtk" => Vtk::import_vtk(path, parser::parse_be), #[cfg(feature = "xml")] ext => { let ft = xml::FileType::try_from_ext(ext) .ok_or(Error::UnknownFileExtension(Some(ext.to_string())))?; let vtk_file = xml::import(path)?; let exp_ft = xml::FileType::from(vtk_file.data_set_type); if ft != exp_ft { Err(Error::XML(xml::Error::TypeExtensionMismatch)) } else { let mut vtk: Vtk = vtk_file.try_into()?; vtk.file_path = Some(path.into()); Ok(vtk) } } #[cfg(not(feature = "xml"))] _ => Err(Error::UnknownFileExtension(None)), } } /// Import a VTK file at the specified path. /// /// This is the async version of [`import`](Vtk::import). /// /// This function determines the vtk file type from the extension as prescribed by the [VTK /// file formats documentation](https://lorensen.github.io/VTKExamples/site/VTKFileFormats/): /// /// - Legacy (`.vtk`) -- Simple legacy file format (Non-XML) /// - Image data (`.vti`) -- Serial vtkImageData (structured) /// - PolyData (`.vtp`) -- Serial vtkPolyData (unstructured) /// - RectilinearGrid (`.vtr`) -- Serial vtkRectilinearGrid (structured) /// - StructuredGrid (`.vts`) -- Serial vtkStructuredGrid (structured) /// - UnstructuredGrid (`.vtu`) -- Serial vtkUnstructuredGrid (unstructured) /// - PImageData (`.pvti`) -- Parallel vtkImageData (structured) /// - PPolyData (`.pvtp`) -- Parallel vtkPolyData (unstructured) /// - PRectilinearGrid (`.pvtr`) -- Parallel vtkRectilinearGrid (structured) /// - PStructuredGrid (`.pvts`) -- Parallel vtkStructuredGrid (structured) /// - PUnstructuredGrid (`.pvtu`) -- Parallel vtkUnstructuredGrid (unstructured) /// /// # Examples /// /// The following example imports a legacy `.vtk` file called `tet.vtk`, and panics with an /// appropriate error message if the file fails to load. /// /// ```should_panic /// use vtkio::Vtk; /// use std::path::PathBuf; /// /// let file_path = PathBuf::from("tet.vtk"); /// /// let mut vtk_file = Vtk::import_async(&file_path).await /// .expect(&format!("Failed to load file: {:?}", file_path)); /// ``` #[cfg(feature = "async_blocked")] pub async fn import_async(file_path: impl AsRef<Path>) -> Result<Vtk, Error> { let path = file_path.as_ref(); let ext = path.extension().and_then(|s| s.to_str()).ok_or()?; match ext { "vtk" => import_vtk_async(path, parser::parse_be).await, #[cfg(feature = "xml")] ext => { let ft = xml::FileType::try_from_ext(ext) .ok_or(Error::UnknownFileExtension(Some(ext.to_string())))?; let vtk_file = xml::import_async(path).await?; let exp_ft = xml::FileType::from(vtk_file.data_set_type); if ft != exp_ft { Err(Error::XML(xml::Error::TypeExtensionMismatch)) } else { Ok(vtk_file.try_into()?) } } #[cfg(not(feature = "xml"))] _ => Err(Error::UnknownFileExtension(None)), } } /// Import an XML VTK file in raw form. /// /// This importer performs a direct translation from the XML string to a Rust representation /// without any decoding or conversion. For a more complete import use [`import`]. /// /// [`VTKFile`] is used internally as an intermediate step for constructing the [`Vtk`] model, /// which has built-in facilities for loading pieces referenced in "parallel" XML formats as well /// as representing Legacy VTK formats, which are more compact when serialized. /// /// [`Vtk`]: model/struct.Vtk.html /// [`VTKFile`]: xml/struct.VTKFile.html /// [`import`]: fn.import.html #[cfg(feature = "unstable")] pub fn import_xml(file_path: impl AsRef<Path>) -> Result<xml::VTKFile, Error> { let path = file_path.as_ref(); let ext = path .extension() .and_then(|s| s.to_str()) .ok_or(Error::UnknownFileExtension(None))?; // Check that the file extension is one of the known ones. let _ = xml::FileType::try_from_ext(ext) .ok_or(Error::UnknownFileExtension(Some(ext.to_string())))?; Ok(xml::import(path)?) } /// Import a legacy VTK file at the specified path. /// /// If the file is in binary format, numeric types will be interpreted in little endian format. /// For the default byte order used by most `.vtk` files use [`import`] or [`import_legacy_be`]. /// /// [`import`]: fn.import.html /// [`import_legacy_be`]: fn.import_legacy_be.html pub fn import_legacy_le(file_path: impl AsRef<Path>) -> Result<Vtk, Error> { Vtk::import_vtk(file_path.as_ref(), parser::parse_le) } #[deprecated(since = "0.6.2", note = "Please use Vtk::import_legacy_le instead")] pub fn import_le(file_path: impl AsRef<Path>) -> Result<Vtk, Error> { Vtk::import_legacy_le(file_path.as_ref()) } /// Import a legacy VTK file at the specified path. /// /// If the file is in binary format, numeric types will be interpreted in big endian format. /// This function behaves the same as [`import`], but expects the given file to be strictly in /// legacy `.vtk` format. /// /// [`import`]: fn.import.html pub fn import_legacy_be(file_path: impl AsRef<Path>) -> Result<Vtk, Error> { Vtk::import_vtk(file_path.as_ref(), parser::parse_be) } #[deprecated(since = "0.6.2", note = "Please use Vtk::import_legacy_be instead")] pub fn import_be(file_path: impl AsRef<Path>) -> Result<Vtk, Error> { Vtk::import_legacy_be(file_path.as_ref()) } /// Export given [`Vtk`] file to the specified file. /// /// The type of file exported is determined by the extension in `file_path`. /// /// Files ending in `.vtk` are exported in binary format. For exporting in ASCII, use /// [`export_ascii`]. /// /// Endianness is determined by the `byte_order` field of the [`Vtk`] type. /// /// # Examples /// /// ```no_run /// use vtkio::model::*; /// use std::path::PathBuf; /// let vtk = Vtk { /// version: Version::new((4,1)), /// byte_order: ByteOrder::BigEndian, /// title: String::from("Tetrahedron"), /// file_path: Some(PathBuf::from("./test.vtk")), /// data: DataSet::inline(UnstructuredGridPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0, 0.0, 1.0, 0.0].into(), /// cells: Cells { /// cell_verts: VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![4, 0, 1, 2, 3] /// }, /// types: vec![CellType::Tetra], /// }, /// data: Attributes::new(), /// }) /// }; /// vtk.export("test.vtk"); /// ``` /// /// [`Vtk`]: struct.Vtk.html /// [`export_ascii`]: fn.export_ascii.html pub fn export(self, file_path: impl AsRef<Path>) -> Result<(), Error> { self.export_impl(file_path.as_ref()) } /// A non-generic helper for the export function. fn export_impl(self, path: &Path) -> Result<(), Error> { let ext = path .extension() .and_then(|s| s.to_str()) .ok_or(Error::UnknownFileExtension(None))?; match ext { "vtk" => { let file = File::create(path)?; BinaryWriter(BufWriter::new(file)).write_vtk(self)?; Ok(()) } #[cfg(feature = "xml")] ext => { let ft = xml::FileType::try_from_ext(ext) .ok_or(Error::UnknownFileExtension(Some(ext.to_string())))?; let vtk_file = xml::VTKFile::try_from(self)?; let exp_ft = xml::FileType::from(vtk_file.data_set_type); if ft != exp_ft { Err(Error::XML(xml::Error::TypeExtensionMismatch)) } else { xml::export(&vtk_file, path)?; Ok(()) } } #[cfg(not(feature = "xml"))] _ => Err(Error::UnknownFileExtension(None)), } } /// Write the given VTK file in binary legacy format to the specified [`Write`](std::io::Write)r. /// /// # Examples /// /// Writing a binary file in big endian format representing a polygon mesh consisting of a single /// triangle: /// /// ``` /// use vtkio::model::*; // import model definition of a VTK file /// /// let mut vtk_bytes = Vec::<u8>::new(); /// /// Vtk { /// version: Version::new((2,0)), /// byte_order: ByteOrder::BigEndian, /// title: String::from("Triangle example"), /// file_path: None, /// data: DataSet::inline(PolyDataPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0].into(), /// polys: Some(VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![3, 0, 1, 2] /// }), /// data: Attributes::new(), /// ..Default::default() /// }) /// }.write_legacy(&mut vtk_bytes); /// /// println!("{}", String::from_utf8_lossy(&vtk_bytes)); /// ``` pub fn write_legacy(self, writer: impl std::io::Write) -> Result<(), Error> { BinaryWriter(writer).write_vtk(self)?; Ok(()) } /// Write the given VTK file in binary legacy format to the specified [`Write`](std::fmt::Write)r. /// /// # Examples /// /// Writing an ASCII file representing a polygon mesh consisting of a single triangle: /// /// ``` /// use vtkio::model::*; // import model definition of a VTK file /// /// let mut vtk_string = String::new(); /// /// Vtk { /// version: Version::new((2,0)), /// byte_order: ByteOrder::BigEndian, // Ignored /// title: String::from("Triangle example"), /// file_path: None, /// data: DataSet::inline(PolyDataPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0].into(), /// polys: Some(VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![3, 0, 1, 2] /// }), /// data: Attributes::new(), /// ..Default::default() /// }) /// }.write_legacy_ascii(&mut vtk_string); /// /// assert_eq!(vtk_string.as_str(), "\ /// ## vtk DataFile Version 2.0 /// Triangle example /// ASCII /// /// DATASET POLYDATA /// POINTS 3 float /// 0 0 0 1 0 0 0 0 -1 /// /// POLYGONS 1 4 /// 3 0 1 2 /// /// POINT_DATA 3 /// /// CELL_DATA 1 /// /// "); /// ``` pub fn write_legacy_ascii(self, writer: impl std::fmt::Write) -> Result<(), Error> { AsciiWriter(writer).write_vtk(self)?; Ok(()) } /// Write the given VTK file in modern XML format to the specified [`Write`](std::io::Write)r. /// /// # Examples /// /// Writing a binary file in big endian format representing a polygon mesh consisting of a single /// triangle: /// /// ``` /// use vtkio::model::*; // import model definition of a VTK file /// /// let mut vtk_bytes = Vec::<u8>::new(); /// /// Vtk { /// version: Version::new((2,0)), /// byte_order: ByteOrder::BigEndian, /// title: String::from("Triangle example"), /// file_path: None, /// data: DataSet::inline(PolyDataPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0].into(), /// polys: Some(VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![3, 0, 1, 2] /// }), /// data: Attributes::new(), /// ..Default::default() /// }) /// }.write_xml(&mut vtk_bytes); /// /// assert_eq!(String::from_utf8_lossy(&vtk_bytes), "\ /// <VTKFile type=\"PolyData\" version=\"2.0\" byte_order=\"BigEndian\" header_type=\"UInt64\">\ /// <PolyData>\ /// <Piece NumberOfPoints=\"3\" NumberOfLines=\"0\" NumberOfStrips=\"0\" NumberOfPolys=\"1\" NumberOfVerts=\"0\">\ /// <PointData/>\ /// <CellData/>\ /// <Points>\ /// <DataArray type=\"Float32\" format=\"binary\" NumberOfComponents=\"3\">\ /// AAAAAAAAACQAAAAAAAAAAAAAAAA/gAAAAAAAAAAAAAAAAAAAAAAAAL+AAAA=\ /// </DataArray>\ /// </Points>\ /// <Polys>\ /// <DataArray type=\"UInt64\" Name=\"connectivity\" format=\"binary\" NumberOfComponents=\"1\">\ /// AAAAAAAAABgAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAI=\ /// </DataArray>\ /// <DataArray type=\"UInt64\" Name=\"offsets\" format=\"binary\" NumberOfComponents=\"1\">\ /// AAAAAAAAAAgAAAAAAAAAAw==\ /// </DataArray>\ /// </Polys>\ /// </Piece>\ /// </PolyData>\ /// </VTKFile>"); /// ``` #[cfg(feature = "xml")] pub fn write_xml(self, writer: impl Write) -> Result<(), Error> { let vtk_file = xml::VTKFile::try_from(self)?; xml::write(&vtk_file, writer)?; Ok(()) } /// Export the VTK data to the specified path in little endian binary format. /// /// This function is used as [`export`] but overrides endiannes. /// /// [`export`]: fn.export.html pub fn export_le(self, file_path: impl AsRef<Path>) -> Result<(), Error> { let file = File::create(file_path.as_ref())?; BinaryWriter(BufWriter::new(file)).write_vtk_le(self)?; Ok(()) } /// Export the VTK data to the specified path in big endian binary format. /// /// This function is used as [`export`] but overrides endiannes. /// /// [`export`]: fn.export.html pub fn export_be(self, file_path: impl AsRef<Path>) -> Result<(), Error> { let file = File::create(file_path.as_ref())?; BinaryWriter(BufWriter::new(file)).write_vtk_be(self)?; Ok(()) } /// Export VTK data to the specified file in ASCII format. /// /// # Examples /// /// ```no_run /// use vtkio::model::*; /// use std::path::PathBuf; /// let vtk = Vtk { /// version: Version::new((4,1)), /// title: String::from("Tetrahedron"), /// byte_order: ByteOrder::BigEndian, /// file_path: Some(PathBuf::from("./test.vtk")), /// data: DataSet::inline(UnstructuredGridPiece { /// points: vec![0.0f32, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, -1.0, 0.0, 1.0, 0.0].into(), /// cells: Cells { /// cell_verts: VertexNumbers::Legacy { /// num_cells: 1, /// vertices: vec![4, 0, 1, 2, 3] /// }, /// types: vec![CellType::Tetra], /// }, /// data: Attributes::new(), /// }) /// }; /// vtk.export_ascii("test.vtk"); /// ``` pub fn export_ascii(self, file_path: impl AsRef<Path>) -> Result<(), Error> { // Ascii formats are typically used for small files, so it makes sense to make the write // in-memory first. let mut out_str = AsciiWriter(String::new()); out_str.write_vtk(self)?; let mut file = File::create(file_path.as_ref())?; file.write_all(out_str.0.as_bytes())?; Ok(()) } }