Share Kind within crate and create OrcaError from Kind
#38
Conversation
| }; | ||
| /// Shorthand for a Result that returns an `OrcaError`. | ||
| pub type Result<T> = result::Result<T, OrcaError>; | ||
| pub(crate) type Result<T> = result::Result<T, OrcaError>; |
There was a problem hiding this comment.
Given we will have methods that will actually return this Result, wouldn't the unavailability of this type definition make the code uncompilable the moment those methods using Result return types are used outside of our crate? Does it act differently if this is a type alias?
| use std::{collections::BTreeMap, fs, ops::Deref, path::PathBuf, result}; | ||
| use tempfile::tempdir; | ||
|
|
||
| pub type Result<T> = result::Result<T, OrcaError>; |
There was a problem hiding this comment.
Given users might also want to use our alias for Result if they work a lot with OrcaError, we might as well treat it as publicly facing interface?
|
After further digging, I learned that it is not necessary for type def to be shared publicly even if used as a return type for a public method as it is just a convenience alias available within the crate (if you so choose). So the concern over the code not compiling was not well founded - sorry! That being said, should we still consider making the alias publicly available? I see it's fairly common to make it public. |
3 participants
No description provided.