Add some docs to FluentBundle::entry

AgriConnect · Oct 27, 2022 · 2e8457e · 2e8457e
1 parent ef71027
commit 2e8457e
Showing 1 changed file with 20 additions and 9 deletions.
diff --git a/fluent-bundle/src/entry.rs b/fluent-bundle/src/entry.rs
@@ -1,4 +1,5 @@
-//! `Entry` is used to store Messages, Terms and Functions in `FluentBundle` instances.
+//! `Entry` is used to store the lookup information for Messages, Terms and Functions in
+//! `FluentBundle` instances.
 
 use std::borrow::Borrow;
 
@@ -12,24 +13,34 @@ use crate::types::FluentValue;
 pub type FluentFunction =
     Box<dyn for<'a> Fn(&[FluentValue<'a>], &FluentArgs) -> FluentValue<'a> + Send + Sync>;
 
+type ResourceIdx = usize;
+type EntryIdx = usize;
+
+/// The [`Entry`] stores indexes into the [`FluentBundle`]'s resources for Messages and Terms,
+/// and owns the [`Box`] pointers to the [`FluentFunction`].
 pub enum Entry {
-    Message((usize, usize)),
-    Term((usize, usize)),
+    Message((ResourceIdx, EntryIdx)),
+    Term((ResourceIdx, EntryIdx)),
     Function(FluentFunction),
 }
 
 pub trait GetEntry {
+    /// Looks up a message by its string ID, and returns it if it exists.
     fn get_entry_message(&self, id: &str) -> Option<&ast::Message<&str>>;
+
+    /// Looks up a term by its string ID, and returns it if it exists.
     fn get_entry_term(&self, id: &str) -> Option<&ast::Term<&str>>;
+
+    /// Looks up a function by its string ID, and returns it if it exists.
     fn get_entry_function(&self, id: &str) -> Option<&FluentFunction>;
 }
 
 impl<'bundle, R: Borrow<FluentResource>, M> GetEntry for FluentBundle<R, M> {
     fn get_entry_message(&self, id: &str) -> Option<&ast::Message<&str>> {
         self.entries.get(id).and_then(|ref entry| match entry {
-            Entry::Message(pos) => {
-                let res = self.resources.get(pos.0)?.borrow();
-                if let ast::Entry::Message(ref msg) = res.get_entry(pos.1)? {
+            Entry::Message((resource_idx, entry_idx)) => {
+                let res = self.resources.get(*resource_idx)?.borrow();
+                if let ast::Entry::Message(ref msg) = res.get_entry(*entry_idx)? {
                     Some(msg)
                 } else {
                     None
@@ -41,9 +52,9 @@ impl<'bundle, R: Borrow<FluentResource>, M> GetEntry for FluentBundle<R, M> {
 
     fn get_entry_term(&self, id: &str) -> Option<&ast::Term<&str>> {
         self.entries.get(id).and_then(|ref entry| match entry {
-            Entry::Term(pos) => {
-                let res = self.resources.get(pos.0)?.borrow();
-                if let ast::Entry::Term(ref msg) = res.get_entry(pos.1)? {
+            Entry::Term((resource_idx, entry_idx)) => {
+                let res = self.resources.get(*resource_idx)?.borrow();
+                if let ast::Entry::Term(ref msg) = res.get_entry(*entry_idx)? {
                     Some(msg)
                 } else {
                     None