Struct Project 

pub struct Project<S> {
    pub id: Option<Uuid>,
    pub file_path: PathBuf,
    pub base_location: UtmLocation,
    pub datum: Datum,
    pub utm_zone: Option<u8>,
    pub survey_files: Vec<DatFile<S>>,
    /* private fields */
}

Fields

id: Option<Uuid>

file_path: PathBuf

The file path to the project file on disk This is used to resolve relative paths to survey data files

Note

igoned for equality checks

base_location: UtmLocation

datum: Datum

utm_zone: Option<u8>

The UTM zone used for fixed stations in the project

survey_files: Vec<DatFile<S>>

Implementations

impl Project<Unloaded>

pub fn read(file_path: impl AsRef<Path>) -> Result<Self, Error>

Read a Compass project file from disk The project file is read from disk and parsed into a ProjectFile struct, but this does not parse the referenced survey data files

Returns

ProjectFile representing the contents of the project file

Errors

• Error::ProjectFileNotFound If the file does not exist
• Error::CouldntReadFile If the file cannot be read

pub fn load_survey_files(self) -> Result<Project<Loaded>, Error>

Read a Compass project’s survey data files from disk The data files are read from the paths specified in the project file

Returns

Project<Loaded> representing the project file, complete with survey data

Errors

• Error::SurveyFileNotFound If a listed survey file does not exist
• Error::CouldntReadFile If the file cannot be read
• Error::CouldntParseSurvey If the survey file cannot be parsed

impl Project<Loaded>

pub fn new( project_id: Option<Uuid>, file_path: impl AsRef<Path>, base_location: UtmLocation, datum: Datum, utm_zone: Option<u8>, ) -> Self

Programmatically create a new compass project

Trait Implementations

impl<S: Clone> Clone for Project<S>

fn clone(&self) -> Project<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for Project<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Project<Loaded>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Project<Unloaded>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.