noth/surrealpatch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update Rust code comments

Browse source
This commit is contained in:
Tobie Morgan Hitchcock 2022-09-16 09:55:18 +01:00
parent 63d8034a60
commit 4c98717f1d
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
lib/src/dbs/options.rs
View file

@ -50,7 +50,7 @@ impl Default for Options {
} }
impl Options { impl Options {
// Create a new Options object /// Create a new Options object
pub fn new(auth: Auth) -> Options { pub fn new(auth: Auth) -> Options {
Options { Options {
ns: None, ns: None,
@ -70,17 +70,17 @@ impl Options {
} }
} }
// Get currently selected NS /// Get currently selected NS
pub fn ns(&self) -> &str { pub fn ns(&self) -> &str {
self.ns.as_ref().unwrap() self.ns.as_ref().unwrap()
} }
// Get currently selected DB /// Get currently selected DB
pub fn db(&self) -> &str { pub fn db(&self) -> &str {
self.db.as_ref().unwrap() self.db.as_ref().unwrap()
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn dive(&self) -> Result<Options, Error> { pub fn dive(&self) -> Result<Options, Error> {
if self.dive < cnf::MAX_RECURSIVE_QUERIES { if self.dive < cnf::MAX_RECURSIVE_QUERIES {
Ok(Options { Ok(Options {
@ -95,7 +95,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn debug(&self, v: bool) -> Options { pub fn debug(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -106,7 +106,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn force(&self, v: bool) -> Options { pub fn force(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -117,7 +117,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn perms(&self, v: bool) -> Options { pub fn perms(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -128,7 +128,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn fields(&self, v: bool) -> Options { pub fn fields(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -139,7 +139,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn events(&self, v: bool) -> Options { pub fn events(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -150,7 +150,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn tables(&self, v: bool) -> Options { pub fn tables(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -161,7 +161,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn indexes(&self, v: bool) -> Options { pub fn indexes(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -172,7 +172,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn import(&self, v: bool) -> Options { pub fn import(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -185,7 +185,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn strict(&self, v: bool) -> Options { pub fn strict(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -196,7 +196,7 @@ impl Options {
} }
} }
// Create a new Options object for a subquery /// Create a new Options object for a subquery
pub fn futures(&self, v: bool) -> Options { pub fn futures(&self, v: bool) -> Options {
Options { Options {
auth: self.auth.clone(), auth: self.auth.clone(),
@ -207,7 +207,7 @@ impl Options {
} }
} }
// Check whether realtime queries are supported /// Check whether realtime queries are supported
pub fn realtime(&self) -> Result<(), Error> { pub fn realtime(&self) -> Result<(), Error> {
if !self.live { if !self.live {
return Err(Error::RealtimeDisabled); return Err(Error::RealtimeDisabled);
@ -215,7 +215,7 @@ impl Options {
Ok(()) Ok(())
} }
// Check whether the authentication permissions are ok /// Check whether the authentication permissions are ok
pub fn check(&self, level: Level) -> Result<(), Error> { pub fn check(&self, level: Level) -> Result<(), Error> {
if !self.auth.check(level) { if !self.auth.check(level) {
return Err(Error::QueryPermissions); return Err(Error::QueryPermissions);
@ -223,7 +223,7 @@ impl Options {
Ok(()) Ok(())
} }
// Check whether the necessary NS / DB options have been set /// Check whether the necessary NS / DB options have been set
pub fn needs(&self, level: Level) -> Result<(), Error> { pub fn needs(&self, level: Level) -> Result<(), Error> {
if self.ns.is_none() && matches!(level, Level::Ns | Level::Db) { if self.ns.is_none() && matches!(level, Level::Ns | Level::Db) {
return Err(Error::NsEmpty); return Err(Error::NsEmpty);