Notable traits for Trailers<'a>

impl&lt;'a&gt; Iterator for Trailers&lt;'a&gt; type Item = TrailerRef&lt;'a&gt;;\"}\n\nStruct git_object::CommitRefIter\n===\n\n\n```\npub struct CommitRefIter<'a> { /* private fields */ }\n```\nLike `CommitRef`, but as `Iterator` to support (up to) entirely allocation free parsing.\nIt’s particularly useful to traverse the commit graph without ever allocating arrays for parents.\n\nImplementations\n---\n\n### impl<'a> CommitRefIter<'a#### pub fn from_bytes(data: &'a [u8]) -> CommitRefIter<'aCreate a commit iterator from data.\n\n#### pub fn tree_id(&mut self) -> Result impl Iterator + 'a\n\nReturn all parent_ids as iterator.\n\nParsing errors are ignored quietly.\n\n#### pub fn signatures(self) -> impl Iterator> + 'a\n\nReturns all signatures, first the author, then the committer, if there is no decoding error.\n\nErrors are coerced into options, hiding whether there was an error or not. The caller knows if there was an error or not if not exactly two signatures were iterable.\nErrors are not the common case - if an error needs to be detectable, use this instance as iterator.\n\n#### pub fn committer(self) -> Result, ErrorReturns the committer signature if there is no decoding error.\n\n#### pub fn author(self) -> Result, ErrorReturns the author signature if there is no decoding error.\n\nIt may contain white space surrounding it, and is exactly as parsed.\n\n#### pub fn message(self) -> Result<&'a BStr, ErrorReturns the message if there is no decoding error.\n\nIt may contain white space surrounding it, and is exactly as\n\nTrait Implementations\n---\n\n### impl<'a> Clone for CommitRefIter<'a#### fn clone(&self) -> CommitRefIter<'aReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n &mut self\n) -> Result<[Self::Item; N], IntoIter>where\n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_next_chunk`)Advances the iterator and returns an array containing the next `N` values. Read more1.0.0 · source#### fn size_hint(&self) -> (usize, Option)\n\nReturns the bounds on the remaining length of the iterator. Read more1.0.0 · source#### fn count(self) -> usizewhere\n Self: Sized,\n\nConsumes the iterator, counting the number of iterations and returning it. Read more1.0.0 · source#### fn last(self) -> Optionwhere\n Self: Sized,\n\nConsumes the iterator, returning the last element. \n Self: Sized,\n\nCreates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more1.0.0 · source#### fn chain(self, other: U) -> Chain::IntoIter>where\n Self: Sized,\n U: IntoIterator,\n\nTakes two iterators and creates a new iterator over both in sequence. Read more1.0.0 · source#### fn zip(self, other: U) -> Zip::IntoIter>where\n Self: Sized,\n U: IntoIterator,\n\n‘Zips up’ two iterators into a single iterator of pairs. \n Self: Sized,\n G: FnMut() -> Self::Item,\n\n🔬This is a nightly-only experimental API. (`iter_intersperse`)Creates a new iterator which places an item generated by `separator`\nbetween adjacent items of the original iterator. Read more1.0.0 · source#### fn map(self, f: F) -> Mapwhere\n Self: Sized,\n F: FnMut(Self::Item) -> B,\n\nTakes a closure and creates an iterator which calls that closure on each element. Read more1.21.0 · source#### fn for_each(self, f: F)where\n Self: Sized,\n F: FnMut(Self::Item),\n\nCalls a closure on each element of an iterator. Read more1.0.0 · source#### fn filter
(self, predicate: P) -> Filterwhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator which uses a closure to determine if an element should be yielded. Read more1.0.0 · source#### fn filter_map(self, f: F) -> FilterMapwhere\n Self: Sized,\n F: FnMut(Self::Item) -> Option,\n\nCreates an iterator that both filters and maps. Read more1.0.0 · source#### fn enumerate(self) -> Enumeratewhere\n Self: Sized,\n\nCreates an iterator which gives the current iteration count as well as the next value. Read more1.0.0 · source#### fn peekable(self) -> Peekablewhere\n Self: Sized,\n\nCreates an iterator which can use the `peek` and `peek_mut` methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more1.0.0 · source#### fn skip_while
(self, predicate: P) -> SkipWhilewhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator that `skip`s elements based on a predicate. Read more1.0.0 · source#### fn take_while
(self, predicate: P) -> TakeWhilewhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator that yields elements based on a predicate. Read more1.57.0 · source#### fn map_while(self, predicate: P) -> MapWhilewhere\n Self: Sized,\n P: FnMut(Self::Item) -> Option,\n\nCreates an iterator that both yields elements based on a predicate and maps. Read more1.0.0 · source#### fn skip(self, n: usize) -> Skipwhere\n Self: Sized,\n\nCreates an iterator that skips the first `n` elements. Read more1.0.0 · source#### fn take(self, n: usize) -> Takewhere\n Self: Sized,\n\nCreates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner. Read more1.0.0 · source#### fn scan(self, initial_state: St, f: F) -> Scanwhere\n Self: Sized,\n F: FnMut(&mut St, Self::Item) -> Option,\n\nAn iterator adapter which, like `fold`, holds internal state, but unlike `fold`, produces a new iterator. Read more1.0.0 · source#### fn flat_map(self, f: F) -> FlatMapwhere\n Self: Sized,\n U: IntoIterator,\n F: FnMut(Self::Item) -> U,\n\nCreates an iterator that works like map, but flattens nested structure. Read more1.0.0 · source#### fn fuse(self) -> Fusewhere\n Self: Sized,\n\nCreates an iterator which ends after the first `None`. Read more1.0.0 · source#### fn inspect(self, f: F) -> Inspectwhere\n Self: Sized,\n F: FnMut(&Self::Item),\n\nDoes something with each element of an iterator, passing the value on. Read more1.0.0 · source#### fn by_ref(&mut self) -> &mut Selfwhere\n Self: Sized,\n\nBorrows an iterator, rather than consuming it. Read more1.0.0 · source#### fn collect(self) -> Bwhere\n B: FromIterator,\n Self: Sized,\n\nTransforms an iterator into a collection. \n E: Extend,\n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_collect_into`)Collects all the items from an iterator into a collection. Read more1.0.0 · source#### fn partition(self, f: F) -> (B, B)where\n Self: Sized,\n B: Default + Extend,\n F: FnMut(&Self::Item) -> bool,\n\nConsumes an iterator, creating two collections from it. \n Self: Sized,\n P: FnMut(Self::Item) -> bool,\n\n🔬This is a nightly-only experimental API. (`iter_is_partitioned`)Checks if the elements of this iterator are partitioned according to the given predicate,\nsuch that all those that return `true` precede all those that return `false`. Read more1.27.0 · source#### fn try_fold(&mut self, init: B, f: F) -> Rwhere\n Self: Sized,\n F: FnMut(B, Self::Item) -> R,\n R: Try
,\n\nAn iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more1.27.0 · source#### fn try_for_each(&mut self, f: F) -> Rwhere\n Self: Sized,\n F: FnMut(Self::Item) -> R,\n R: Try
,\n\nAn iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more1.0.0 · source#### fn fold(self, init: B, f: F) -> Bwhere\n Self: Sized,\n F: FnMut(B, Self::Item) -> B,\n\nFolds every element into an accumulator by applying an operation,\nreturning the final result. Read more1.51.0 · source#### fn reduce(self, f: F) -> Optionwhere\n Self: Sized,\n F: FnMut(Self::Item, Self::Item) -> Self::Item,\n\nReduces the elements to a single one, by repeatedly applying a reducing operation. \n &mut self,\n f: F\n) -> <::Residual as Residual::Output>>>::TryTypewhere\n Self: Sized,\n F: FnMut(Self::Item, Self::Item) -> R,\n R: Try
,\n ::Residual: Residual>,\n\n🔬This is a nightly-only experimental API. (`iterator_try_reduce`)Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more1.0.0 · source#### fn all(&mut self, f: F) -> boolwhere\n Self: Sized,\n F: FnMut(Self::Item) -> bool,\n\nTests if every element of the iterator matches a predicate. Read more1.0.0 · source#### fn any(&mut self, f: F) -> boolwhere\n Self: Sized,\n F: FnMut(Self::Item) -> bool,\n\nTests if any element of the iterator matches a predicate. Read more1.0.0 · source#### fn find
(&mut self, predicate: P) -> Optionwhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nSearches for an element of an iterator that satisfies a predicate. Read more1.30.0 · source#### fn find_map(&mut self, f: F) -> Optionwhere\n Self: Sized,\n F: FnMut(Self::Item) -> Option,\n\nApplies function to the elements of iterator and returns the first non-none result. \n &mut self,\n f: F\n) -> <::Residual as Residual>>::TryTypewhere\n Self: Sized,\n F: FnMut(&Self::Item) -> R,\n R: Try
,\n ::Residual: Residual>,\n\n🔬This is a nightly-only experimental API. (`try_find`)Applies function to the elements of iterator and returns the first true result or the first error. Read more1.0.0 · source#### fn position
(&mut self, predicate: P) -> Optionwhere\n Self: Sized,\n P: FnMut(Self::Item) -> bool,\n\nSearches for an element in an iterator, returning its index. Read more1.6.0 · source#### fn max_by_key(self, f: F) -> Optionwhere\n B: Ord,\n Self: Sized,\n F: FnMut(&Self::Item) -> B,\n\nReturns the element that gives the maximum value from the specified function. Read more1.15.0 · source#### fn max_by(self, compare: F) -> Optionwhere\n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Ordering,\n\nReturns the element that gives the maximum value with respect to the specified comparison function. Read more1.6.0 · source#### fn min_by_key(self, f: F) -> Optionwhere\n B: Ord,\n Self: Sized,\n F: FnMut(&Self::Item) -> B,\n\nReturns the element that gives the minimum value from the specified function. Read more1.15.0 · source#### fn min_by(self, compare: F) -> Optionwhere\n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Ordering,\n\nReturns the element that gives the minimum value with respect to the specified comparison function. Read more1.0.0 · source#### fn unzip(self) -> (FromA, FromB)where\n FromA: Default + Extend,\n FromB: Default + Extend,\n Self: Sized + Iterator,\n\nConverts an iterator of pairs into a pair of containers. Read more1.36.0 · source#### fn copied<'a, T>(self) -> Copiedwhere\n T: 'a + Copy,\n Self: Sized + Iterator,\n\nCreates an iterator which copies all of its elements. Read more1.0.0 · source#### fn cloned<'a, T>(self) -> Clonedwhere\n T: 'a + Clone,\n Self: Sized + Iterator,\n\nCreates an iterator which `clone`s all of its elements. Read more1.0.0 · source#### fn cycle(self) -> Cyclewhere\n Self: Sized + Clone,\n\nRepeats an iterator endlessly. \n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_array_chunks`)Returns an iterator over `N` elements of the iterator at a time. Read more1.11.0 · source#### fn sum(self) -> Swhere\n Self: Sized,\n S: Sum,\n\nSums the elements of an iterator. Read more1.11.0 · source#### fn product
(self) -> Pwhere\n Self: Sized,\n P: Product,\n\nIterates over the entire iterator, multiplying all the elements \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> Ordering,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more1.5.0 · source#### fn partial_cmp(self, other: I) -> Optionwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nLexicographically compares the elements of this `Iterator` with those of another. \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> Option,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more1.5.0 · source#### fn eq(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialEq<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are equal to those of another. \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> bool,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. Read more1.5.0 · source#### fn ne(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialEq<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are unequal to those of another. Read more1.5.0 · source#### fn lt(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically less than those of another. Read more1.5.0 · source#### fn le(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more1.5.0 · source#### fn gt(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically greater than those of another. Read more1.5.0 · source#### fn ge(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. \n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Option,\n\n🔬This is a nightly-only experimental API. (`is_sorted`)Checks if the elements of this iterator are sorted using the given comparator function. \n Self: Sized,\n F: FnMut(Self::Item) -> K,\n K: PartialOrd,\n\n🔬This is a nightly-only experimental API. (`is_sorted`)Checks if the elements of this iterator are sorted using the given key extraction function. \n---\n\n### impl<'a> RefUnwindSafe for CommitRefIter<'a### impl<'a> Send for CommitRefIter<'a### impl<'a> Sync for CommitRefIter<'a### impl<'a> Unpin for CommitRefIter<'a### impl<'a> UnwindSafe for CommitRefIter<'aBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl IntoIterator for Iwhere\n I: Iterator,\n\n#### type Item = ::Item\n\nThe type of the elements being iterated over.#### type IntoIter = I\n\nWhich kind of iterator are we turning this into?const: unstable · source#### fn into_iter(self) -> I\n\nCreates an iterator from a value. \n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.{\"CommitRefIter<'a>\":\"
Notable traits for CommitRefIter&lt;'a&gt;
impl&lt;'a&gt; Iterator for CommitRefIter&lt;'a&gt; type Item = Result&lt;Token&lt;'a&gt;, Error&gt;;\"}\n\nStruct git_object::Data\n===\n\n\n```\npub struct Data<'a> {\n    pub kind: Kind,\n    pub data: &'a [u8],\n}\n```\nA borrowed object using a slice as backing buffer, or in other words a bytes buffer that knows the kind of object it represents.\n\nFields\n---\n\n`kind: Kind`kind of object\n\n`data: &'a [u8]`decoded, decompressed data, owned by a backing store.\n\nImplementations\n---\n\n### impl Data<'_#### pub fn verify_checksum(&self, desired: impl AsRef) -> Result<(), ErrorCompute the checksum of `self` and compare it with the `desired` hash.\nIf the hashes do not match, an `Error` is returned, containing the actual hash of `self`.\n\n### impl<'a> Data<'a#### pub fn new(kind: Kind, data: &'a [u8]) -> Data<'aConstructs a new data object from `kind` and `data`.\n\n#### pub fn decode(&self) -> Result, ErrorDecodes the data in the backing slice into a `ObjectRef`, allowing to access all of its data conveniently. The cost of parsing an object is negligible.\n\n**Note** that mutable, decoded objects can be created from `Data`\nusing `crate::ObjectRef::into_owned()`.\n\n#### pub fn try_into_tree_iter(self) -> OptionReturns this object as tree iterator to parse entries one at a time to avoid allocations, or\n`None` if this is not a tree object.\n\n#### pub fn try_into_commit_iter(self) -> OptionReturns this object as commit iterator to parse tokens one at a time to avoid allocations, or\n`None` if this is not a commit object.\n\n#### pub fn try_into_tag_iter(self) -> OptionReturns this object as tag iterator to parse tokens one at a time to avoid allocations, or\n`None` if this is not a tag object.\n\nTrait Implementations\n---\n\n### impl<'a> Clone for Data<'a#### fn clone(&self) -> Data<'aReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\nFormats the value using the given formatter. \n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl<'a> PartialOrd> for Data<'a#### fn partial_cmp(&self, other: &Data<'a>) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n---\n\n### impl<'a> RefUnwindSafe for Data<'a### impl<'a> Send for Data<'a### impl<'a> Sync for Data<'a### impl<'a> Unpin for Data<'a### impl<'a> UnwindSafe for Data<'aBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl ToOwned for Twhere\n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.\n\nStruct git_object::Tag\n===\n\n\n```\npub struct Tag {\n    pub target: ObjectId,\n    pub target_kind: Kind,\n    pub name: BString,\n    pub tagger: Option,\n    pub message: BString,\n    pub pgp_signature: Option,\n}\n```\nA mutable git tag.\n\nFields\n---\n\n`target: ObjectId`The hash this tag is pointing to.\n\n`target_kind: Kind`The kind of object this tag is pointing to.\n\n`name: BString`The name of the tag, e.g. “v1.0”.\n\n`tagger: Option`The tags author.\n\n`message: BString`The message describing the tag.\n\n`pgp_signature: Option`A pgp signature over all bytes of the encoded tag, excluding the pgp signature itself.\n\nTrait Implementations\n---\n\n### impl Clone for Tag\n\n#### fn clone(&self) -> Tag\n\nReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\n#### fn fmt(&self, f: &mut Formatter<'_>) -> Result\n\nFormats the value using the given formatter. \n\n#### fn deserialize<__D>(__deserializer: __D) -> Resultwhere\n __D: Deserializer<'de>,\n\nDeserialize this value from the given Serde deserializer. \n\n#### fn from(v: Tag) -> Self\n\nConverts to this type from the input type.### impl From> for Tag\n\n#### fn from(other: TagRef<'_>) -> Tag\n\nConverts to this type from the input type.### impl Hash for Tag\n\n#### fn hash<__H: Hasher>(&self, state: &mut __H)\n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n\n#### fn cmp(&self, other: &Tag) -> Ordering\n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\n#### fn eq(&self, other: &Tag) -> bool\n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl PartialOrd for Tag\n\n#### fn partial_cmp(&self, other: &Tag) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n\n#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n __S: Serializer,\n\nSerialize this value into the given Serde serializer. \n\n#### type Error = Object\n\nThe type returned in the event of a conversion error.#### fn try_from(value: Object) -> Result Result<()Write a representation of this instance to `out`.#### fn kind(&self) -> Kind\n\nReturns the type of this object.#### fn size(&self) -> usize\n\nReturns the size of this object’s representation (the amount of data which would be written by `write_to`). \n\n### impl StructuralEq for Tag\n\n### impl StructuralPartialEq for Tag\n\nAuto Trait Implementations\n---\n\n### impl RefUnwindSafe for Tag\n\n### impl Send for Tag\n\n### impl Sync for Tag\n\n### impl Unpin for Tag\n\n### impl UnwindSafe for Tag\n\nBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl ToOwned for Twhere\n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.### impl DeserializeOwned for Twhere\n T: for<'de> Deserialize<'de>,\n\nStruct git_object::TagRef\n===\n\n\n```\npub struct TagRef<'a> {\n    pub target: &'a BStr,\n    pub target_kind: Kind,\n    pub name: &'a BStr,\n    pub tagger: Option>,\n    pub message: &'a BStr,\n    pub pgp_signature: Option<&'a BStr>,\n}\n```\nRepresents a git tag, commonly indicating a software release.\n\nFields\n---\n\n`target: &'a BStr`The hash in hexadecimal being the object this tag points to. Use `target()` to obtain a byte representation.\n\n`target_kind: Kind`The kind of object that `target` points to.\n\n`name: &'a BStr`The name of the tag, e.g. “v1.0”.\n\n`tagger: Option>`The author of the tag.\n\n`message: &'a BStr`The message describing this release.\n\n`pgp_signature: Option<&'a BStr>`A cryptographic signature over the entire content of the serialized tag object thus far.\n\nImplementations\n---\n\n### impl<'a> TagRef<'a#### pub fn from_bytes(data: &'a [u8]) -> Result, ErrorDeserialize a tag from `data`.\n\n#### pub fn target(&self) -> ObjectId\n\nThe object this tag points to as `Id`.\n\nTrait Implementations\n---\n\n### impl<'a> Clone for TagRef<'a#### fn clone(&self) -> TagRef<'aReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\nFormats the value using the given formatter. \n __D: Deserializer<'de>,\n\nDeserialize this value from the given Serde deserializer. \n\n#### fn from(other: TagRef<'_>) -> Tag\n\nConverts to this type from the input type.### impl<'a> From> for ObjectRef<'a#### fn from(v: TagRef<'a>) -> Self\n\nConverts to this type from the input type.### impl<'a> Hash for TagRef<'a#### fn hash<__H: Hasher>(&self, state: &mut __H)\n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl<'a> PartialOrd> for TagRef<'a#### fn partial_cmp(&self, other: &TagRef<'a>) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n __S: Serializer,\n\nSerialize this value into the given Serde serializer. \n\nReturns the type of this object.#### fn size(&self) -> usize\n\nReturns the size of this object’s representation (the amount of data which would be written by `write_to`). \n---\n\n### impl<'a> RefUnwindSafe for TagRef<'a### impl<'a> Send for TagRef<'a### impl<'a> Sync for TagRef<'a### impl<'a> Unpin for TagRef<'a### impl<'a> UnwindSafe for TagRef<'aBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl ToOwned for Twhere\n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.### impl DeserializeOwned for Twhere\n T: for<'de> Deserialize<'de>,\n\nStruct git_object::TagRefIter\n===\n\n\n```\npub struct TagRefIter<'a> { /* private fields */ }\n```\nLike `TagRef`, but as `Iterator` to support entirely allocation free parsing.\nIt’s particularly useful to dereference only the target chain.\n\nImplementations\n---\n\n### impl<'a> TagRefIter<'a#### pub fn from_bytes(data: &'a [u8]) -> TagRefIter<'aCreate a tag iterator from data.\n\n#### pub fn target_id(self) -> Result Result>, ErrorReturns the taggers signature if there is no decoding error, and if this field exists.\nErrors are coerced into options, hiding whether there was an error or not. The caller knows if there was an error or not.\n\nTrait Implementations\n---\n\n### impl<'a> Clone for TagRefIter<'a#### fn clone(&self) -> TagRefIter<'aReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n &mut self\n) -> Result<[Self::Item; N], IntoIter>where\n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_next_chunk`)Advances the iterator and returns an array containing the next `N` values. Read more1.0.0 · source#### fn size_hint(&self) -> (usize, Option)\n\nReturns the bounds on the remaining length of the iterator. Read more1.0.0 · source#### fn count(self) -> usizewhere\n Self: Sized,\n\nConsumes the iterator, counting the number of iterations and returning it. Read more1.0.0 · source#### fn last(self) -> Optionwhere\n Self: Sized,\n\nConsumes the iterator, returning the last element. \n Self: Sized,\n\nCreates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more1.0.0 · source#### fn chain(self, other: U) -> Chain::IntoIter>where\n Self: Sized,\n U: IntoIterator,\n\nTakes two iterators and creates a new iterator over both in sequence. Read more1.0.0 · source#### fn zip(self, other: U) -> Zip::IntoIter>where\n Self: Sized,\n U: IntoIterator,\n\n‘Zips up’ two iterators into a single iterator of pairs. \n Self: Sized,\n G: FnMut() -> Self::Item,\n\n🔬This is a nightly-only experimental API. (`iter_intersperse`)Creates a new iterator which places an item generated by `separator`\nbetween adjacent items of the original iterator. Read more1.0.0 · source#### fn map(self, f: F) -> Mapwhere\n Self: Sized,\n F: FnMut(Self::Item) -> B,\n\nTakes a closure and creates an iterator which calls that closure on each element. Read more1.21.0 · source#### fn for_each(self, f: F)where\n Self: Sized,\n F: FnMut(Self::Item),\n\nCalls a closure on each element of an iterator. Read more1.0.0 · source#### fn filter
(self, predicate: P) -> Filterwhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator which uses a closure to determine if an element should be yielded. Read more1.0.0 · source#### fn filter_map(self, f: F) -> FilterMapwhere\n Self: Sized,\n F: FnMut(Self::Item) -> Option,\n\nCreates an iterator that both filters and maps. Read more1.0.0 · source#### fn enumerate(self) -> Enumeratewhere\n Self: Sized,\n\nCreates an iterator which gives the current iteration count as well as the next value. Read more1.0.0 · source#### fn peekable(self) -> Peekablewhere\n Self: Sized,\n\nCreates an iterator which can use the `peek` and `peek_mut` methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more1.0.0 · source#### fn skip_while
(self, predicate: P) -> SkipWhilewhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator that `skip`s elements based on a predicate. Read more1.0.0 · source#### fn take_while
(self, predicate: P) -> TakeWhilewhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator that yields elements based on a predicate. Read more1.57.0 · source#### fn map_while(self, predicate: P) -> MapWhilewhere\n Self: Sized,\n P: FnMut(Self::Item) -> Option,\n\nCreates an iterator that both yields elements based on a predicate and maps. Read more1.0.0 · source#### fn skip(self, n: usize) -> Skipwhere\n Self: Sized,\n\nCreates an iterator that skips the first `n` elements. Read more1.0.0 · source#### fn take(self, n: usize) -> Takewhere\n Self: Sized,\n\nCreates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner. Read more1.0.0 · source#### fn scan(self, initial_state: St, f: F) -> Scanwhere\n Self: Sized,\n F: FnMut(&mut St, Self::Item) -> Option,\n\nAn iterator adapter which, like `fold`, holds internal state, but unlike `fold`, produces a new iterator. Read more1.0.0 · source#### fn flat_map(self, f: F) -> FlatMapwhere\n Self: Sized,\n U: IntoIterator,\n F: FnMut(Self::Item) -> U,\n\nCreates an iterator that works like map, but flattens nested structure. Read more1.0.0 · source#### fn fuse(self) -> Fusewhere\n Self: Sized,\n\nCreates an iterator which ends after the first `None`. Read more1.0.0 · source#### fn inspect(self, f: F) -> Inspectwhere\n Self: Sized,\n F: FnMut(&Self::Item),\n\nDoes something with each element of an iterator, passing the value on. Read more1.0.0 · source#### fn by_ref(&mut self) -> &mut Selfwhere\n Self: Sized,\n\nBorrows an iterator, rather than consuming it. Read more1.0.0 · source#### fn collect(self) -> Bwhere\n B: FromIterator,\n Self: Sized,\n\nTransforms an iterator into a collection. \n E: Extend,\n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_collect_into`)Collects all the items from an iterator into a collection. Read more1.0.0 · source#### fn partition(self, f: F) -> (B, B)where\n Self: Sized,\n B: Default + Extend,\n F: FnMut(&Self::Item) -> bool,\n\nConsumes an iterator, creating two collections from it. \n Self: Sized,\n P: FnMut(Self::Item) -> bool,\n\n🔬This is a nightly-only experimental API. (`iter_is_partitioned`)Checks if the elements of this iterator are partitioned according to the given predicate,\nsuch that all those that return `true` precede all those that return `false`. Read more1.27.0 · source#### fn try_fold(&mut self, init: B, f: F) -> Rwhere\n Self: Sized,\n F: FnMut(B, Self::Item) -> R,\n R: Try
,\n\nAn iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more1.27.0 · source#### fn try_for_each(&mut self, f: F) -> Rwhere\n Self: Sized,\n F: FnMut(Self::Item) -> R,\n R: Try
,\n\nAn iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more1.0.0 · source#### fn fold(self, init: B, f: F) -> Bwhere\n Self: Sized,\n F: FnMut(B, Self::Item) -> B,\n\nFolds every element into an accumulator by applying an operation,\nreturning the final result. Read more1.51.0 · source#### fn reduce(self, f: F) -> Optionwhere\n Self: Sized,\n F: FnMut(Self::Item, Self::Item) -> Self::Item,\n\nReduces the elements to a single one, by repeatedly applying a reducing operation. \n &mut self,\n f: F\n) -> <::Residual as Residual::Output>>>::TryTypewhere\n Self: Sized,\n F: FnMut(Self::Item, Self::Item) -> R,\n R: Try
,\n ::Residual: Residual>,\n\n🔬This is a nightly-only experimental API. (`iterator_try_reduce`)Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more1.0.0 · source#### fn all(&mut self, f: F) -> boolwhere\n Self: Sized,\n F: FnMut(Self::Item) -> bool,\n\nTests if every element of the iterator matches a predicate. Read more1.0.0 · source#### fn any(&mut self, f: F) -> boolwhere\n Self: Sized,\n F: FnMut(Self::Item) -> bool,\n\nTests if any element of the iterator matches a predicate. Read more1.0.0 · source#### fn find
(&mut self, predicate: P) -> Optionwhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nSearches for an element of an iterator that satisfies a predicate. Read more1.30.0 · source#### fn find_map(&mut self, f: F) -> Optionwhere\n Self: Sized,\n F: FnMut(Self::Item) -> Option,\n\nApplies function to the elements of iterator and returns the first non-none result. \n &mut self,\n f: F\n) -> <::Residual as Residual>>::TryTypewhere\n Self: Sized,\n F: FnMut(&Self::Item) -> R,\n R: Try
,\n ::Residual: Residual>,\n\n🔬This is a nightly-only experimental API. (`try_find`)Applies function to the elements of iterator and returns the first true result or the first error. Read more1.0.0 · source#### fn position
(&mut self, predicate: P) -> Optionwhere\n Self: Sized,\n P: FnMut(Self::Item) -> bool,\n\nSearches for an element in an iterator, returning its index. Read more1.6.0 · source#### fn max_by_key(self, f: F) -> Optionwhere\n B: Ord,\n Self: Sized,\n F: FnMut(&Self::Item) -> B,\n\nReturns the element that gives the maximum value from the specified function. Read more1.15.0 · source#### fn max_by(self, compare: F) -> Optionwhere\n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Ordering,\n\nReturns the element that gives the maximum value with respect to the specified comparison function. Read more1.6.0 · source#### fn min_by_key(self, f: F) -> Optionwhere\n B: Ord,\n Self: Sized,\n F: FnMut(&Self::Item) -> B,\n\nReturns the element that gives the minimum value from the specified function. Read more1.15.0 · source#### fn min_by(self, compare: F) -> Optionwhere\n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Ordering,\n\nReturns the element that gives the minimum value with respect to the specified comparison function. Read more1.0.0 · source#### fn unzip(self) -> (FromA, FromB)where\n FromA: Default + Extend,\n FromB: Default + Extend,\n Self: Sized + Iterator,\n\nConverts an iterator of pairs into a pair of containers. Read more1.36.0 · source#### fn copied<'a, T>(self) -> Copiedwhere\n T: 'a + Copy,\n Self: Sized + Iterator,\n\nCreates an iterator which copies all of its elements. Read more1.0.0 · source#### fn cloned<'a, T>(self) -> Clonedwhere\n T: 'a + Clone,\n Self: Sized + Iterator,\n\nCreates an iterator which `clone`s all of its elements. Read more1.0.0 · source#### fn cycle(self) -> Cyclewhere\n Self: Sized + Clone,\n\nRepeats an iterator endlessly. \n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_array_chunks`)Returns an iterator over `N` elements of the iterator at a time. Read more1.11.0 · source#### fn sum(self) -> Swhere\n Self: Sized,\n S: Sum,\n\nSums the elements of an iterator. Read more1.11.0 · source#### fn product
(self) -> Pwhere\n Self: Sized,\n P: Product,\n\nIterates over the entire iterator, multiplying all the elements \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> Ordering,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more1.5.0 · source#### fn partial_cmp(self, other: I) -> Optionwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nLexicographically compares the elements of this `Iterator` with those of another. \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> Option,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more1.5.0 · source#### fn eq(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialEq<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are equal to those of another. \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> bool,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. Read more1.5.0 · source#### fn ne(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialEq<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are unequal to those of another. Read more1.5.0 · source#### fn lt(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically less than those of another. Read more1.5.0 · source#### fn le(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more1.5.0 · source#### fn gt(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically greater than those of another. Read more1.5.0 · source#### fn ge(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. \n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Option,\n\n🔬This is a nightly-only experimental API. (`is_sorted`)Checks if the elements of this iterator are sorted using the given comparator function. \n Self: Sized,\n F: FnMut(Self::Item) -> K,\n K: PartialOrd,\n\n🔬This is a nightly-only experimental API. (`is_sorted`)Checks if the elements of this iterator are sorted using the given key extraction function. \n---\n\n### impl<'a> RefUnwindSafe for TagRefIter<'a### impl<'a> Send for TagRefIter<'a### impl<'a> Sync for TagRefIter<'a### impl<'a> Unpin for TagRefIter<'a### impl<'a> UnwindSafe for TagRefIter<'aBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl IntoIterator for Iwhere\n I: Iterator,\n\n#### type Item = ::Item\n\nThe type of the elements being iterated over.#### type IntoIter = I\n\nWhich kind of iterator are we turning this into?const: unstable · source#### fn into_iter(self) -> I\n\nCreates an iterator from a value. \n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.{\"TagRefIter<'a>\":\"
Notable traits for TagRefIter&lt;'a&gt;
impl&lt;'a&gt; Iterator for TagRefIter&lt;'a&gt; type Item = Result&lt;Token&lt;'a&gt;, Error&gt;;\"}\n\nStruct git_object::Tree\n===\n\n\n```\npub struct Tree {\n    pub entries: Vec,\n}\n```\nA mutable Tree, containing other trees, blobs or commits.\n\nFields\n---\n\n`entries: Vec`The directories and files contained in this tree. They must be and remain sorted by `filename`.\n\nImplementations\n---\n\n### impl Tree\n\n#### pub fn empty() -> Self\n\nReturn an empty tree which serializes to a well-known hash\n\nTrait Implementations\n---\n\n### impl Clone for Tree\n\n#### fn clone(&self) -> Tree\n\nReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\n#### fn fmt(&self, f: &mut Formatter<'_>) -> Result\n\nFormats the value using the given formatter. \n\n#### fn deserialize<__D>(__deserializer: __D) -> Resultwhere\n __D: Deserializer<'de>,\n\nDeserialize this value from the given Serde deserializer. \n\n#### fn from(v: Tree) -> Self\n\nConverts to this type from the input type.### impl From> for Tree\n\n#### fn from(other: TreeRef<'_>) -> Tree\n\nConverts to this type from the input type.### impl Hash for Tree\n\n#### fn hash<__H: Hasher>(&self, state: &mut __H)\n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n\n#### fn cmp(&self, other: &Tree) -> Ordering\n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\n#### fn eq(&self, other: &Tree) -> bool\n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl PartialOrd for Tree\n\n#### fn partial_cmp(&self, other: &Tree) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n\n#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n __S: Serializer,\n\nSerialize this value into the given Serde serializer. \n\n#### type Error = Object\n\nThe type returned in the event of a conversion error.#### fn try_from(value: Object) -> Result Result<()Serialize this tree to `out` in the git internal format.\n\n#### fn size(&self) -> usize\n\nReturns the size of this object’s representation (the amount of data which would be written by `write_to`). \n\nReturns the type of this object.#### fn loose_header(&self) -> SmallVec<[u8; 28]Returns a loose object header based on the object’s data### impl Eq for Tree\n\n### impl StructuralEq for Tree\n\n### impl StructuralPartialEq for Tree\n\nAuto Trait Implementations\n---\n\n### impl RefUnwindSafe for Tree\n\n### impl Send for Tree\n\n### impl Sync for Tree\n\n### impl Unpin for Tree\n\n### impl UnwindSafe for Tree\n\nBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl ToOwned for Twhere\n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.### impl DeserializeOwned for Twhere\n T: for<'de> Deserialize<'de>,\n\nStruct git_object::TreeRef\n===\n\n\n```\npub struct TreeRef<'a> {\n    pub entries: Vec>,\n}\n```\nA directory snapshot containing files (blobs), directories (trees) and submodules (commits).\n\nFields\n---\n\n`entries: Vec>`The directories and files contained in this tree.\n\nImplementations\n---\n\n### impl<'a> TreeRef<'a#### pub fn from_bytes(data: &'a [u8]) -> Result, ErrorDeserialize a Tree from `data`.\n\n#### pub const fn empty() -> TreeRef<'staticCreate an instance of the empty tree.\n\nIt’s particularly useful as static part of a program.\n\nTrait Implementations\n---\n\n### impl<'a> Clone for TreeRef<'a#### fn clone(&self) -> TreeRef<'aReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\nFormats the value using the given formatter. \n __D: Deserializer<'de>,\n\nDeserialize this value from the given Serde deserializer. \n\n#### fn from(other: TreeRef<'_>) -> Tree\n\nConverts to this type from the input type.### impl<'a> From> for ObjectRef<'a#### fn from(v: TreeRef<'a>) -> Self\n\nConverts to this type from the input type.### impl<'a> Hash for TreeRef<'a#### fn hash<__H: Hasher>(&self, state: &mut __H)\n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl<'a> PartialOrd> for TreeRef<'a#### fn partial_cmp(&self, other: &TreeRef<'a>) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n __S: Serializer,\n\nSerialize this value into the given Serde serializer. \n\n#### fn write_to(&self, out: impl Write) -> Result<()Serialize this tree to `out` in the git internal format.\n\n#### fn size(&self) -> usize\n\nReturns the size of this object’s representation (the amount of data which would be written by `write_to`). \n\nReturns the type of this object.#### fn loose_header(&self) -> SmallVec<[u8; 28]Returns a loose object header based on the object’s data### impl<'a> Eq for TreeRef<'a### impl<'a> StructuralEq for TreeRef<'a### impl<'a> StructuralPartialEq for TreeRef<'aAuto Trait Implementations\n---\n\n### impl<'a> RefUnwindSafe for TreeRef<'a### impl<'a> Send for TreeRef<'a### impl<'a> Sync for TreeRef<'a### impl<'a> Unpin for TreeRef<'a### impl<'a> UnwindSafe for TreeRef<'aBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl ToOwned for Twhere\n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.### impl DeserializeOwned for Twhere\n T: for<'de> Deserialize<'de>,\n\nStruct git_object::TreeRefIter\n===\n\n\n```\npub struct TreeRefIter<'a> { /* private fields */ }\n```\nA directory snapshot containing files (blobs), directories (trees) and submodules (commits), lazily evaluated.\n\nImplementations\n---\n\n### impl<'a> TreeRefIter<'a#### pub fn from_bytes(data: &'a [u8]) -> TreeRefIter<'aInstantiate an iterator from the given tree data.\n\n### impl<'a> TreeRefIter<'a#### pub fn entries(self) -> Result>, ErrorConsume self and return all parsed entries.\n\nTrait Implementations\n---\n\n### impl<'a> Clone for TreeRefIter<'a#### fn clone(&self) -> TreeRefIter<'aReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\nFormats the value using the given formatter. \n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n &mut self\n) -> Result<[Self::Item; N], IntoIter>where\n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_next_chunk`)Advances the iterator and returns an array containing the next `N` values. Read more1.0.0 · source#### fn size_hint(&self) -> (usize, Option)\n\nReturns the bounds on the remaining length of the iterator. Read more1.0.0 · source#### fn count(self) -> usizewhere\n Self: Sized,\n\nConsumes the iterator, counting the number of iterations and returning it. Read more1.0.0 · source#### fn last(self) -> Optionwhere\n Self: Sized,\n\nConsumes the iterator, returning the last element. \n Self: Sized,\n\nCreates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more1.0.0 · source#### fn chain(self, other: U) -> Chain::IntoIter>where\n Self: Sized,\n U: IntoIterator,\n\nTakes two iterators and creates a new iterator over both in sequence. Read more1.0.0 · source#### fn zip(self, other: U) -> Zip::IntoIter>where\n Self: Sized,\n U: IntoIterator,\n\n‘Zips up’ two iterators into a single iterator of pairs. \n Self: Sized,\n G: FnMut() -> Self::Item,\n\n🔬This is a nightly-only experimental API. (`iter_intersperse`)Creates a new iterator which places an item generated by `separator`\nbetween adjacent items of the original iterator. Read more1.0.0 · source#### fn map(self, f: F) -> Mapwhere\n Self: Sized,\n F: FnMut(Self::Item) -> B,\n\nTakes a closure and creates an iterator which calls that closure on each element. Read more1.21.0 · source#### fn for_each(self, f: F)where\n Self: Sized,\n F: FnMut(Self::Item),\n\nCalls a closure on each element of an iterator. Read more1.0.0 · source#### fn filter
(self, predicate: P) -> Filterwhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator which uses a closure to determine if an element should be yielded. Read more1.0.0 · source#### fn filter_map(self, f: F) -> FilterMapwhere\n Self: Sized,\n F: FnMut(Self::Item) -> Option,\n\nCreates an iterator that both filters and maps. Read more1.0.0 · source#### fn enumerate(self) -> Enumeratewhere\n Self: Sized,\n\nCreates an iterator which gives the current iteration count as well as the next value. Read more1.0.0 · source#### fn peekable(self) -> Peekablewhere\n Self: Sized,\n\nCreates an iterator which can use the `peek` and `peek_mut` methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more1.0.0 · source#### fn skip_while
(self, predicate: P) -> SkipWhilewhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator that `skip`s elements based on a predicate. Read more1.0.0 · source#### fn take_while
(self, predicate: P) -> TakeWhilewhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nCreates an iterator that yields elements based on a predicate. Read more1.57.0 · source#### fn map_while(self, predicate: P) -> MapWhilewhere\n Self: Sized,\n P: FnMut(Self::Item) -> Option,\n\nCreates an iterator that both yields elements based on a predicate and maps. Read more1.0.0 · source#### fn skip(self, n: usize) -> Skipwhere\n Self: Sized,\n\nCreates an iterator that skips the first `n` elements. Read more1.0.0 · source#### fn take(self, n: usize) -> Takewhere\n Self: Sized,\n\nCreates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner. Read more1.0.0 · source#### fn scan(self, initial_state: St, f: F) -> Scanwhere\n Self: Sized,\n F: FnMut(&mut St, Self::Item) -> Option,\n\nAn iterator adapter which, like `fold`, holds internal state, but unlike `fold`, produces a new iterator. Read more1.0.0 · source#### fn flat_map(self, f: F) -> FlatMapwhere\n Self: Sized,\n U: IntoIterator,\n F: FnMut(Self::Item) -> U,\n\nCreates an iterator that works like map, but flattens nested structure. Read more1.0.0 · source#### fn fuse(self) -> Fusewhere\n Self: Sized,\n\nCreates an iterator which ends after the first `None`. Read more1.0.0 · source#### fn inspect(self, f: F) -> Inspectwhere\n Self: Sized,\n F: FnMut(&Self::Item),\n\nDoes something with each element of an iterator, passing the value on. Read more1.0.0 · source#### fn by_ref(&mut self) -> &mut Selfwhere\n Self: Sized,\n\nBorrows an iterator, rather than consuming it. Read more1.0.0 · source#### fn collect(self) -> Bwhere\n B: FromIterator,\n Self: Sized,\n\nTransforms an iterator into a collection. \n E: Extend,\n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_collect_into`)Collects all the items from an iterator into a collection. Read more1.0.0 · source#### fn partition(self, f: F) -> (B, B)where\n Self: Sized,\n B: Default + Extend,\n F: FnMut(&Self::Item) -> bool,\n\nConsumes an iterator, creating two collections from it. \n Self: Sized,\n P: FnMut(Self::Item) -> bool,\n\n🔬This is a nightly-only experimental API. (`iter_is_partitioned`)Checks if the elements of this iterator are partitioned according to the given predicate,\nsuch that all those that return `true` precede all those that return `false`. Read more1.27.0 · source#### fn try_fold(&mut self, init: B, f: F) -> Rwhere\n Self: Sized,\n F: FnMut(B, Self::Item) -> R,\n R: Try
,\n\nAn iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more1.27.0 · source#### fn try_for_each(&mut self, f: F) -> Rwhere\n Self: Sized,\n F: FnMut(Self::Item) -> R,\n R: Try
,\n\nAn iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more1.0.0 · source#### fn fold(self, init: B, f: F) -> Bwhere\n Self: Sized,\n F: FnMut(B, Self::Item) -> B,\n\nFolds every element into an accumulator by applying an operation,\nreturning the final result. Read more1.51.0 · source#### fn reduce(self, f: F) -> Optionwhere\n Self: Sized,\n F: FnMut(Self::Item, Self::Item) -> Self::Item,\n\nReduces the elements to a single one, by repeatedly applying a reducing operation. \n &mut self,\n f: F\n) -> <::Residual as Residual::Output>>>::TryTypewhere\n Self: Sized,\n F: FnMut(Self::Item, Self::Item) -> R,\n R: Try
,\n ::Residual: Residual>,\n\n🔬This is a nightly-only experimental API. (`iterator_try_reduce`)Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more1.0.0 · source#### fn all(&mut self, f: F) -> boolwhere\n Self: Sized,\n F: FnMut(Self::Item) -> bool,\n\nTests if every element of the iterator matches a predicate. Read more1.0.0 · source#### fn any(&mut self, f: F) -> boolwhere\n Self: Sized,\n F: FnMut(Self::Item) -> bool,\n\nTests if any element of the iterator matches a predicate. Read more1.0.0 · source#### fn find
(&mut self, predicate: P) -> Optionwhere\n Self: Sized,\n P: FnMut(&Self::Item) -> bool,\n\nSearches for an element of an iterator that satisfies a predicate. Read more1.30.0 · source#### fn find_map(&mut self, f: F) -> Optionwhere\n Self: Sized,\n F: FnMut(Self::Item) -> Option,\n\nApplies function to the elements of iterator and returns the first non-none result. \n &mut self,\n f: F\n) -> <::Residual as Residual>>::TryTypewhere\n Self: Sized,\n F: FnMut(&Self::Item) -> R,\n R: Try
,\n ::Residual: Residual>,\n\n🔬This is a nightly-only experimental API. (`try_find`)Applies function to the elements of iterator and returns the first true result or the first error. Read more1.0.0 · source#### fn position
(&mut self, predicate: P) -> Optionwhere\n Self: Sized,\n P: FnMut(Self::Item) -> bool,\n\nSearches for an element in an iterator, returning its index. Read more1.6.0 · source#### fn max_by_key(self, f: F) -> Optionwhere\n B: Ord,\n Self: Sized,\n F: FnMut(&Self::Item) -> B,\n\nReturns the element that gives the maximum value from the specified function. Read more1.15.0 · source#### fn max_by(self, compare: F) -> Optionwhere\n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Ordering,\n\nReturns the element that gives the maximum value with respect to the specified comparison function. Read more1.6.0 · source#### fn min_by_key(self, f: F) -> Optionwhere\n B: Ord,\n Self: Sized,\n F: FnMut(&Self::Item) -> B,\n\nReturns the element that gives the minimum value from the specified function. Read more1.15.0 · source#### fn min_by(self, compare: F) -> Optionwhere\n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Ordering,\n\nReturns the element that gives the minimum value with respect to the specified comparison function. Read more1.0.0 · source#### fn unzip(self) -> (FromA, FromB)where\n FromA: Default + Extend,\n FromB: Default + Extend,\n Self: Sized + Iterator,\n\nConverts an iterator of pairs into a pair of containers. Read more1.36.0 · source#### fn copied<'a, T>(self) -> Copiedwhere\n T: 'a + Copy,\n Self: Sized + Iterator,\n\nCreates an iterator which copies all of its elements. Read more1.0.0 · source#### fn cloned<'a, T>(self) -> Clonedwhere\n T: 'a + Clone,\n Self: Sized + Iterator,\n\nCreates an iterator which `clone`s all of its elements. Read more1.0.0 · source#### fn cycle(self) -> Cyclewhere\n Self: Sized + Clone,\n\nRepeats an iterator endlessly. \n Self: Sized,\n\n🔬This is a nightly-only experimental API. (`iter_array_chunks`)Returns an iterator over `N` elements of the iterator at a time. Read more1.11.0 · source#### fn sum(self) -> Swhere\n Self: Sized,\n S: Sum,\n\nSums the elements of an iterator. Read more1.11.0 · source#### fn product
(self) -> Pwhere\n Self: Sized,\n P: Product,\n\nIterates over the entire iterator, multiplying all the elements \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> Ordering,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more1.5.0 · source#### fn partial_cmp(self, other: I) -> Optionwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nLexicographically compares the elements of this `Iterator` with those of another. \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> Option,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more1.5.0 · source#### fn eq(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialEq<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are equal to those of another. \n Self: Sized,\n I: IntoIterator,\n F: FnMut(Self::Item, ::Item) -> bool,\n\n🔬This is a nightly-only experimental API. (`iter_order_by`)Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. Read more1.5.0 · source#### fn ne(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialEq<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are unequal to those of another. Read more1.5.0 · source#### fn lt(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically less than those of another. Read more1.5.0 · source#### fn le(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more1.5.0 · source#### fn gt(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically greater than those of another. Read more1.5.0 · source#### fn ge(self, other: I) -> boolwhere\n I: IntoIterator,\n Self::Item: PartialOrd<::Item>,\n Self: Sized,\n\nDetermines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. \n Self: Sized,\n F: FnMut(&Self::Item, &Self::Item) -> Option,\n\n🔬This is a nightly-only experimental API. (`is_sorted`)Checks if the elements of this iterator are sorted using the given comparator function. \n Self: Sized,\n F: FnMut(Self::Item) -> K,\n K: PartialOrd,\n\n🔬This is a nightly-only experimental API. (`is_sorted`)Checks if the elements of this iterator are sorted using the given key extraction function. \n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl<'a> PartialOrd> for TreeRefIter<'a#### fn partial_cmp(&self, other: &TreeRefIter<'a>) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n---\n\n### impl<'a> RefUnwindSafe for TreeRefIter<'a### impl<'a> Send for TreeRefIter<'a### impl<'a> Sync for TreeRefIter<'a### impl<'a> Unpin for TreeRefIter<'a### impl<'a> UnwindSafe for TreeRefIter<'aBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl IntoIterator for Iwhere\n I: Iterator,\n\n#### type Item = ::Item\n\nThe type of the elements being iterated over.#### type IntoIter = I\n\nWhich kind of iterator are we turning this into?const: unstable · source#### fn into_iter(self) -> I\n\nCreates an iterator from a value. \n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.{\"TreeRefIter<'a>\":\"
Notable traits for TreeRefIter&lt;'a&gt;
impl&lt;'a&gt; Iterator for TreeRefIter&lt;'a&gt; type Item = Result&lt;EntryRef&lt;'a&gt;, Error&gt;;\"}\n\nEnum git_object::Kind\n===\n\n\n```\npub enum Kind {\n    Tree,\n    Blob,\n    Commit,\n    Tag,\n}\n```\nThe four types of objects that git differentiates. #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]\n\nVariants\n---\n\n### Tree\n\n### Blob\n\n### Commit\n\n### Tag\n\nImplementations\n---\n\n### impl Kind\n\n#### pub fn from_bytes(s: &[u8]) -> Result &[u8] \n\nReturn the name of `self` for use in serialized loose git objects.\n\nTrait Implementations\n---\n\n### impl Clone for Kind\n\n#### fn clone(&self) -> Kind\n\nReturns a copy of the value. Read more1.0.0 · source#### fn clone_from(&mut self, source: &Self)\n\nPerforms copy-assignment from `source`. \n\n#### fn fmt(&self, f: &mut Formatter<'_>) -> Result\n\nFormats the value using the given formatter. \n\n#### fn deserialize<__D>(__deserializer: __D) -> Resultwhere\n __D: Deserializer<'de>,\n\nDeserialize this value from the given Serde deserializer. \n\n#### fn fmt(&self, f: &mut Formatter<'_>) -> Result\n\nFormats the value using the given formatter. \n\n#### fn hash<__H: Hasher>(&self, state: &mut __H)\n\nFeeds this value into the given `Hasher`. Read more1.3.0 · source#### fn hash_slice(data: &[Self], state: &mut H)where\n H: Hasher,\n Self: Sized,\n\nFeeds a slice of this type into the given `Hasher`. \n\n#### fn cmp(&self, other: &Kind) -> Ordering\n\nThis method returns an `Ordering` between `self` and `other`. Read more1.21.0 · source#### fn max(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the maximum of two values. Read more1.21.0 · source#### fn min(self, other: Self) -> Selfwhere\n Self: Sized,\n\nCompares and returns the minimum of two values. Read more1.50.0 · source#### fn clamp(self, min: Self, max: Self) -> Selfwhere\n Self: Sized + PartialOrd,\n\nRestrict a value to a certain interval. \n\n#### fn eq(&self, other: &Kind) -> bool\n\nThis method tests for `self` and `other` values to be equal, and is used by `==`.1.0.0 · source#### fn ne(&self, other: &Rhs) -> bool\n\nThis method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.### impl PartialOrd for Kind\n\n#### fn partial_cmp(&self, other: &Kind) -> Option bool\n\nThis method tests less than (for `self` and `other`) and is used by the `<` operator. Read more1.0.0 · source#### fn le(&self, other: &Rhs) -> bool\n\nThis method tests less than or equal to (for `self` and `other`) and is used by the `<=`\noperator. Read more1.0.0 · source#### fn gt(&self, other: &Rhs) -> bool\n\nThis method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more1.0.0 · source#### fn ge(&self, other: &Rhs) -> bool\n\nThis method tests greater than or equal to (for `self` and `other`) and is used by the `>=`\noperator. \n\n#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n __S: Serializer,\n\nSerialize this value into the given Serde serializer. \n\n### impl Eq for Kind\n\n### impl StructuralEq for Kind\n\n### impl StructuralPartialEq for Kind\n\nAuto Trait Implementations\n---\n\n### impl RefUnwindSafe for Kind\n\n### impl Send for Kind\n\n### impl Sync for Kind\n\n### impl Unpin for Kind\n\n### impl UnwindSafe for Kind\n\nBlanket Implementations\n---\n\n### impl Any for Twhere\n T: 'static + ?Sized,\n\n#### fn type_id(&self) -> TypeId\n\nGets the `TypeId` of `self`. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow(&self) -> &T\n\nImmutably borrows from an owned value. \n T: ?Sized,\n\nconst: unstable · source#### fn borrow_mut(&mut self) -> &mut T\n\nMutably borrows from an owned value. \n\nconst: unstable · source#### fn from(t: T) -> T\n\nReturns the argument unchanged.\n\n### impl Into for Twhere\n U: From,\n\nconst: unstable · source#### fn into(self) -> U\n\nCalls `U::from(self)`.\n\nThat is, this conversion is whatever the implementation of\n`From for U` chooses to do.\n\n### impl ToOwned for Twhere\n T: Clone,\n\n#### type Owned = T\n\nThe resulting type after obtaining ownership.#### fn to_owned(&self) -> T\n\nCreates owned data from borrowed data, usually by cloning. \n\nUses borrowed data to replace owned data, usually by cloning. \n T: Display + ?Sized,\n\n#### default fn to_string(&self) -> String\n\nConverts the given value to a `String`. \n U: Into,\n\n#### type Error = Infallible\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_from(value: U) -> Result>::ErrorPerforms the conversion.### impl TryInto for Twhere\n U: TryFrom,\n\n#### type Error = >::Error\n\nThe type returned in the event of a conversion error.const: unstable · source#### fn try_into(self) -> Result>::ErrorPerforms the conversion.### impl DeserializeOwned for Twhere\n T: for<'de> Deserialize<'de>,\n\n{\"&[u8]\":\"
Notable traits for &amp;[u8]
impl Read for &amp;[u8]impl Write for &amp;mut [u8]\"}\n\nTrait git_object::WriteTo\n===\n\n\n```\npub trait WriteTo {\n    // Required methods\n    fn write_to(&self, out: impl Write) -> Result<()>;\n    fn kind(&self) -> Kind;\n    fn size(&self) -> usize;\n\n    // Provided method\n    fn loose_header(&self) -> SmallVec<[u8; 28]> { ... }\n}\n```\nWriting of objects to a `Write` implementation\n\nRequired Methods\n---\n\n#### fn write_to(&self, out: impl Write) -> Result<()Write a representation of this instance to `out`.\n\n#### fn kind(&self) -> Kind\n\nReturns the type of this object.\n\n#### fn size(&self) -> usize\n\nReturns the size of this object’s representation (the amount of data which would be written by `write_to`).\n\n`size`’s value has no bearing on the validity of the object, as such it’s possible for `size` to return a sensible value but `write_to` to fail because the object was not actually valid in some way.\n\nProvided Methods\n---\n\n#### fn loose_header(&self) -> SmallVec<[u8; 28]Returns a loose object header based on the object’s data\n\nImplementations on Foreign Types\n---\n\n### impl WriteTo for &Twhere\n T: WriteTo,\n\n#### fn write_to(&self, out: impl Write) -> Result<()#### fn size(&self) -> usize\n\n#### fn kind(&self) -> Kind\n\nImplementors\n---\n\n### impl WriteTo for Object\n\nSerialization\n\n### impl WriteTo for Blob\n\n### impl WriteTo for Commit\n\n### impl WriteTo for Tag\n\n### impl WriteTo for Tree\n\nSerialization\n\n### impl<'a> WriteTo for ObjectRef<'aSerialization\n\n### impl<'a> WriteTo for BlobRef<'a### impl<'a> WriteTo for CommitRef<'a### impl<'a> WriteTo for TagRef<'a### impl<'a> WriteTo for TreeRef<'aSerialization"}}},{"rowIdx":447,"cells":{"project":{"kind":"string","value":"esparta_github_io_gitimmersion-spanish"},"source":{"kind":"string","value":"free_programming_book"},"language":{"kind":"string","value":"Unknown"},"content":{"kind":"string","value":"* Configurar git para tenerlo listo para trabajar.\n\n## Configurar Nombre y Correo Electrónico01\n\nSi no ha usado git antes, necesita configurarlo primero. Ejecute los siguientes comandos para que git conozca su nombre y correo electrónico. Si ya tenía configurado git, puede saltarse esta sección.\n\n > git config --global user.name \"\"\n > git config --global user.email \"\"\n\n## Configure las preferencias de fin de línea 02\n\nPara usuarios de Unix/Mac:\n\nPara usuarios de Windows:\n\n* Obtener el material de configuración y estar listos para iniciar.\n\n## Obtener el paquete del Tutorial. 01\n\nObtenga los paquetes del tutorial desde:\n\n* La memorias provistas en este tutorial.\n * La URL del tutorial original http://gitimmersion.com/git_tutorial.zip\n * Clone este tutorial desde https://github.com/esparta/gitimmersion-spanish\n\n## Contenido del tutorial 02\n\nEl paquete contiene un directorio principal “git_tutorial” con tres subdirectorios:\n\n* html — Estos archivos en formato HTML. Apunte su navegador a html/index.html para comenzar a leer offline.\n * work — Un directorio vacío. Cree sus repos aquí.\n * repos — Repositorios Git pre-empacados con los que puede llevar el tutorial en cualquier punto. De llegar a bloquearse, sólo copie el laboratorio deseado en su directorio de trabajo.\n\n* Aprender a crear un repositorio git desde cero.\n\n## Crear un programa “Hola, Mundo” 01\n\n Haga un directorio vacío llamado “hello”, después cree un archivo llamado `hello.rb` con el siguiente contenido. \n\n > mkdir hello\n > cd hello\n\n > puts \"Hello, World\"\n\n## Crear el Repositorio 02\n\nYa tiene un directorio con un archivo. Para crear el repositorio git a partir de este directorio, ejecute el comando git init.\n\n > git init\n\n > $ git init Initialized empty Git repository in /Users/jerrynummi/Projects/edgecase/git_immersion/auto/hello/.git/\n\n## Agregue el programa al repositorio 03\n\nAhora vamos a agregar el programa “Hola, Mundo” al repositorio.\n\n > git add hello.rb\n > git commit -m \"First Commit\"\n\n > $ git add hello.rb $ git commit -m \"First Commit\" [master (root-commit) 3cbf83b] First Commit 1 files changed, 1 insertions(+), 0 deletions(-) create mode 100644 hello.rb\n\n* Aprender a revisar el estatus del repositorio.\n\n## Revisar el estatus de el repositorio 01\n\n Use el comando `git status` para revisar el estatus actual del repositorio. \n\nDebería ver\n\nEl comando de status reporta que no hay nada por hacer commit. Esto significa que el repositorio tiene el mismo estado actual que el directorio de trabajo. No hay cambios pendientes de grabar.\n Usaremos el comando `git status` para continuar monitoreando el estado entre el repositorio y el directorio de trabajo.\n\n* Aprender a monitorear el estado del directorio de trabajo.\n\n## Cambie el programa “Hola, Mundo”. 01\n\nEs tiempo de cambiar nuestro programa hello para tomar un argumento desde la línea de comando. Cambie el archivo para que sea:\n\n > puts \"Hello, #{ARGV.first}!\"\n\n > $ git status # On branch master # Changes not staged for commit: # (use \"git add ...\" to update what will be committed) # (use \"git checkout -- ...\" to discard changes in working directory) # # modified: hello.rb # no changes added to commit (use \"git add\" and/or \"git commit -a\")\n La primera cosa a notar es que git sabe que el archivo `hello.rb` ha sido modificado, pero git no ha sido notificado de esos cambios. También note que el mensaje de estatus le proporciona algunos consejos sobre lo que debería hacer a continuación. Si desea agregar estos cambios al repositorio, entonces use el comando `git add` . Mientras tanto, el comando  `git checkout` puede ser usado para descartar los cambios. \n\nPoner en Stage el cambio.\n\n* Aprender cómo poner en Stage cambios para un posterior Commit.\n\n## Agregar cambios 01\n\nDecirle a git que ponga en Stage los cambios. Revisar el estatus.\n\n > git add hello.rb\n > git status\n\n > $ git add hello.rb $ git status # On branch master # Changes to be committed: # (use \"git reset HEAD ...\" to unstage) # # modified: hello.rb #\n El cambio al archivo `hello.rb` se ha puesto en Stage. Esto significa que git ahora tiene conocimiento del cambio, pero todavía no ha sido guardado permanentemente en el repositorio. La siguiente operación de Commit incluirá los cambios en Stage. Si al final decide que no quiere realizar el Commit de los cambios, el comando de estatus le recordará que el commando `git reset` puede ser usado para quitarlo de Stage.\n\nUn paso separado del concepto de Staging está alineado con la filosofía de \"salirse del camino\" hasta que se necesite hacer frente al control de código fuente. Puede continuar haciendo cambios en su directorio de trabajo, y entonces, en el punto en que quiera interactuar con el control de código fuente, git le permitirá grabar los cambios en pequeños Commits que reproducirán exactamente lo que hizo.\n Por ejemplo, suponga que quiere editar tres archivos: `a.rb` ,  `b.rb` , and  `c.rb` . Ahora desea hacer Commit de todos los cambios, pero desea que los cambios en  `a.rb` y  `b.rb` estén en un Commit, mientras que los cambios de  `c.rb` no están relacionados lógicamente con los primeros dos archivos y debería estar en un Commit separado. \nPuede realizar lo siguiente:\n > git add a.rb\n > git add b.rb\n > git commit -m \"Changes for a and b\"\n > git add c.rb\n > git commit -m \"Unrelated change to c\"\n\nSeparando los Staging y Commits le dará la habilidad de afinar con precisión qué pasó en cada Commit.\n\n* Aprender a hacer Commit a los cambios en el repositorio.\n\n## Haga Commit a los cambios 01\n\nOk, suficiente de Staging. Hagamos Commit a lo que hemos tenido en Stage al repositorio.\n Cuando usa el comando `git commit` previamente para confirmar la versión inicial del archivo  `hello.rb` en el repositorio, puede incluir la opción  `-m` que establece un comentario desde la línea de comando. El comando Commit permitirá comentar interactivamente la edición del comentario del Commit. Intentaremos esto ahora mismo. Si omite la opción `-m` en la línea de comando, git lanzará el editor de su preferencia. El editor es escogido de la siguiente lista (en orden de prioridad): \n\n* La variable de ambiente GIT_EDITOR\n * El ajuste en la configuración de core.editor\n * La variable de ambiente VISUAL\n * La variable de ambiente EDITOR\n Yo tengo la variable EDITOR establecida a `emacsclient` . \nHaga un Commit y revise el estatus.\n\n > git commit\n\nDeberá ver lo siguiente en su editor:\n\n > | # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # On branch master # Changes to be committed: # (use \"git reset HEAD ...\" to unstage) # # modified: hello.rb #\n\nEn la primera línea, escriba el comentario: “Using ARGV”. Guarde el archivo y salga del editor. Deberá ver …\n\n > git commit Waiting for Emacs... [master 569aa96] Using ARGV 1 files changed, 1 insertions(+), 1 deletions(-)\n La línea “Waiting for Emacs…” es del programa `emacsclient` quien envía el archivo a un programa de emacs y espera que el se cierre el archivo. El resto de la salida es el mensaje estándar del Commit. \n\n## Revise el estatus 02\n\nFinalmente vamos a revisar de nuevo el estatus.\n\nEl directorio de trabajo está limpio y listo para continuar.\n\n* Aprender que git trabaja con cambios, no con archivos.\n\nMuchos sistemas de control de versiones trabajan con archivos. Se agrega un archivo al control de versiones y el sistema rastreará los cambios al archivo al que apunta.\n Git se enfoca en los cambios al archivo en vez del archivo mismo. Cuando escribe `git add file` , no le está diciendo a git que agregue el archivo al repositorio. En vez de eso, se le dice a git que debería notar el estado actual de ese archivo al que se le hará un Commit después. \nIntentaremos explorar esta diferencia en este laboratorio.\n\n## Primer cambio: Permitir un nombre por defecto 01\n\nCambie el programa “” para tener un valor por defecto si no se proporciona el argumento en la línea de comando.\n\n > name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\n## Agregue este cambio 02\n\nAhora agregue este cambio al área de Staging de git.\n\n## Segundo cambio: Agregue un comentario 03\n\nAhora agregue un comentario al programa “”.\n\n## Revise el estatus actual 04\n\n > $ git status # On branch master # Changes to be committed: # (use \"git reset HEAD ...\" to unstage) # # modified: hello.rb # # Changes not staged for commit: # (use \"git add ...\" to update what will be committed) # (use \"git checkout -- ...\" to discard changes in working directory) # # modified: hello.rb #\n Observe cómo se lista `hello.rb` dos veces en el estatus. El primer cambio (agregando un valor por defecto) está en Stage y listo para el Commit. El segundo cambio (agregando un comentario) no está en Stage. Si realizara el Commit ahora mismo, el comentario no será almacenado en el repositorio. \nIntentemos eso.\n\n## Realizando Committ 05\n\nConfirme el cambio en el área de Stage (el valor por defecto),y revise de nuevo es estatus.\n\n > git commit -m \"Added a default value\"\n > git status\n\n > $ git commit -m \"Added a default value\" [master 1b754e9] Added a default value 1 files changed, 3 insertions(+), 1 deletions(-) $ git status # On branch master # Changes not staged for commit: # (use \"git add ...\" to update what will be committed) # (use \"git checkout -- ...\" to discard changes in working directory) # # modified: hello.rb # no changes added to commit (use \"git add\" and/or \"git commit -a\")\n El comando estatus nos dice que `hello.rb` tiene cambios no guardados, pero ya no está en el área de Staging. \n\n## Agregue el segundo cambio 06\n\nAhora agregue el segundo cambio al área de Staging, después ejecute git status.\n\n > git add .\n > git status\n\nNota: Usamos el directorio actual (‘.’) como el archivo a agregar. Esto es un atajo realmente conveniente para agregar todos los cambios en los archivos en el directorio actual. Pero como esto agrega todo, es una realmente buena idea revisar el estatus antes de realizar un \"add .\", sólo para asegurarse de no agregar archivos que no tenía intenciones de agregar.\n\nDeseaba repasar el truco de “add .” , pero continuaré agregando archivos explícitamente en el resto del tutorial sólo para estar seguros.\n\nAhora el segundo cambio está en el Stage y listo para el Commit.\n\n## Commit del segundo cambio 07\n\n > git commit -m \"Added a comment\"\n\n* Aprender a ver el historial de un proyecto.\n La función del comando `git log` es obtener el listado de qué cambios se han realizado. \n\n > $ git log commit 40543214b69016a1f079a0d95ff88cc7421e9b54 Author:   Date: Tue Mar 6 16:12:08 2012 -0500 Added a comment commit 1b754e9e5d528ed7a7d82c3b380fa2b2faa3ce00 Author:   Date: Tue Mar 6 16:12:08 2012 -0500 Added a default value commit 30534911b25d1fab76d13d269ff6215b4c4acddd Author:   Date: Tue Mar 6 16:12:08 2012 -0500 Using ARGV commit 3cbf83b6899697985d2b4fcfae9b254ab6d0ddf7 Author:   Date: Tue Mar 6 16:12:07 2012 -0500 First Commit\n\nÉsta es la lista de los cuatro cambios que hemos hecho en el repositorio hasta ahora.\n\n## Historias en una línea 01\n\n Se tiene un gran reto de controlar exactamente qué despliega el comando `log` .  En lo personal, me gusta en formato de una sola línea: \n\n > $ git log --pretty=oneline 40543214b69016a1f079a0d95ff88cc7421e9b54 Added a comment 1b754e9e5d528ed7a7d82c3b380fa2b2faa3ce00 Added a default value 30534911b25d1fab76d13d269ff6215b4c4acddd Using ARGV 3cbf83b6899697985d2b4fcfae9b254ab6d0ddf7 First Commit\n\n## Controlando cuáles entradas se muestran 02\n\nExisten muchas opciones para seleccionar cuántas entradas se muestran en el log. Juegue con alguna de las siguientes opciones:\n > git log --pretty=oneline --max-count=2\n > git log --pretty=oneline --since='5 minutes ago'\n > git log --pretty=oneline --until='5 minutes ago'\n > git log --pretty=oneline --author=\n > git log --pretty=oneline --all\n\nVea man git-log para todos los detalles.\n\n## Embelleciéndolo 03\n\n Aquí está lo que uso para revisar los cambios hechos en la última semana. Agregaría `--author=jim` si sólo quisiera ver los cambios que yo he hecho.. > git log --all --pretty=format:\"%h %cd %s (%an)\" --since='7 days ago'\n\n## Lo último en formatos de Log 04\n\nConforme pase el tiempo, he decidido que me gusta el siguiente formato para el log en la mayoría de mis trabajos.\n\n > git log --pretty=format:\"%h %ad | %s%d [%an]\" --graph --date=short\n\nSe vería así:\n\n > $ git log --pretty=format:\"%h %ad | %s%d [%an]\" --graph --date=short * 4054321 2012-03-06 | Added a comment (HEAD, master) [Jim Weirich] * 1b754e9 2012-03-06 | Added a default value [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [Jim Weirich] * 3cbf83b 2012-03-06 | First Commit [Jim Weirich]\n\nMirémoslo a detalle:\n\n* \n `--pretty=\"...\"` define el formato de la salida. * \n `%h` es el hash abreviado del Commit * \n `%d` son algunos decorados en el Commit (por ejemplo, la cabecera del branch heads o los tags) * \n `%ad` es la fecha en que se realizó * \n `%s` el comentario * \n `%an` el nombre del autor * \n `--graph` informa a git que despliegue el arbol de Commit en un layout gráfico en código ASCII * \n `--date=short` mantiene la fecha en formato bonito y corto \nEsto es mucho como para escribir en cada ocasión que desee ver el log. Afortunadamente aprenderemos sobre los alias en git en el próximo laboratorio.\n\n## Otra herramientas 05\n\n Tanto `gitx` (para Macs) y  `gitk` (cualquier plataforma) son útiles para explorar el historial.\n\n### Goals\n\n* Aprender a configurar alias y atajos para los comandos de git.\n\n## Alias Comunes 01\n\n, , , y son algunos comandos comunes a los cuales es útil tenerle abreviaciones.\n\nAgregue los siguientes al archivo .gitconfig localizado en su directorio $HOME .\n\n# Archivo: $HOME/.gitconfig\n\n > [alias] co = checkout ci = commit st = status br = branch hist = log --pretty=format:\\\"%h %ad | %s%d [%an]\\\" --graph --date=short type = cat-file -t dump = cat-file -p\n Ya hemos revisado con anterioridad checkout, commit y status. En el laboratorio previo acabamos de cubrir el comando `log` . Una vez modificado el archivo .gitconfig podrá escribir  `git co` donde solía escribir  `git checkout` .  Lo mismo sucede con  `git st` para  `git status` y  `git ci` para  `git commit` .  El mejor de ellos es  `git hist` , que permitirá evitar el realmente largo comando  `log` visto con anterioridad. \nContinúe e intente estos nuevos comandos.\n\n## Definir el alias\n\n `hist` en su archivo  `.gitconfig` 02 Para la mayor parte de este tutorial, continuaré escribiendo los comandos completos en las instrucciones. La única excepción será el uso del alias `hist` definido anteriormente, en cualquier momento en que necesitemos ver la salida del comando. Asegurese de tener el alias  `hist` configurado en su archivo  `.gitconfig` antes de continuar. \n\n## \n\n `Escribir` y  `Volcar` 03 Hemos agregado unos cuantos alias para comandos que aún no hemos revisamos. El coamdndo `git branch` será visto pronto. Por su parte, el comando  `git cat-file` será util explorando git, como veremos dentro de poco. \n\n## Alias de Shell (Opcional) 04\n\nNota: Esta sección es para los que están ejecutando un shell parecido a posix. Lo usuarios de Windows y otros usuarios con shell no-posix pueden sentirse libres de omitir el siguiente laboratorio.\n\nSi su shell soporta alias y atajos, entonces puede agregar alias en este nivel también. Aquí están los que yo uso:\n\n# Archivo: .profile\n\n > alias gs='git status ' alias ga='git add ' alias gb='git branch ' alias gc='git commit' alias gd='git diff' alias go='git checkout ' alias gk='gitk --all&' alias gx='gitx --all' alias got='git ' alias get='git '\n La abreviatura `go` para  `git checkout` es particularmente buena, ya que permite escribir: > go  git hist\n Nota: ¿No olvidó definir el alias `hist` en su archivo  `.gitconfig` , verdad?  De lo contrario, revise el laboratorio de Alias. \n\n > $ git hist * 4054321 2012-03-06 | Added a comment (HEAD, master) [Jim Weirich] * 1b754e9 2012-03-06 | Added a default value [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [Jim Weirich] * 3cbf83b 2012-03-06 | First Commit [Jim Weirich]\n Examine la salida del log output y busque el hash de el primer Commit. Debe ser la última línea de la salida de `git hist` . Use el último código hash (con los primeros 7 caracteres será suficiente) en el comando a continuación. Después revise el contenido del archivo hello.rb . \n\n > git checkout \n > cat hello.rb\n\nNota: Los comandos dados son comandos Unix y sirven de igual forma tanto en equipos Mac y Linux. Desafortunadamente, los usuarios de Windows tendrán que trasladarlo a sus comandos nativos.\n\nNota: Muchos comandos dependen del valor del hash en el repositorio. Debido a que los valores hash serán diferentes a los míos, donde sea que vea algo como  o  en la línea de comandos, sustituyalo por el hash correspondiente en su repositorio.\n\n > $ git checkout 3cbf83b Note: checking out '3cbf83b'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b new_branch_name HEAD is now at 3cbf83b... First Commit $ cat hello.rb puts \"Hello, World\"\n La salida del comando `checkout` explica la situación bastante bien. Las versiones antiguas de git se quejarán de no estar en el branch local. En cualquier caso, no se preocupe sobre eso por ahora. \nObserve que el contenido del archivo hello.rb es el contenido original.\n\n## Regrese a la última versión en el branch master 02\n\n > git checkout master\n > cat hello.rb\n\n > $ git checkout master Previous HEAD position was 3cbf83b... First Commit Switched to branch 'master' $ cat hello.rb # Default is \"World\" name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\n‘master’ es el nombre del branch actual. Al hacer checking out por nombre, se toma la última versión del branch.\n\n### metas\n\n* Aprender a etiquetar Commits con nombres para futuras referencias.\n\nLlamemos a la versión actual de el programa \"version 1 (v1)\".\n\n## Etiquetar version 1 01\n\nAhora puede referirse a la versión actual del programa como v1.\n\n## Etiquetar versiones previas 02\n\n Etiquetemos la versión anterior a la actual como version v1-beta. Primero necesitamos hacer un checkout en la versión anterior. En vez de buscar el hash, usaremos la notación `^` para indicar “el padre de v1”. Nota: Si la notación `v1` ^ le da algún problema, puede tambien intentar con  `v1~1` , lo cuál referencia a la misma versión. Esta notación significa “el primer antecesor de v1”. \n\n > git checkout v1^\n > cat hello.rb\n\n > $ git checkout v1^ Note: checking out 'v1^'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b new_branch_name HEAD is now at 1b754e9... Added a default value $ cat hello.rb name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\nComo puede observar, esta es la versión con el valor por defecto antes de que agregaramos el comentario. Hagamos esta versión v1-beta.\n\n > git tag v1-beta\n\n## Checking Out usando etiquetas 03\n\nAhora intente ir hacia tras y hacia adelante entre las dos versiones etiquetadas.\n\n > git checkout v1\n > git checkout v1-beta\n\n > $ git checkout v1 Previous HEAD position was 1b754e9... Added a default value HEAD is now at 4054321... Added a comment $ git checkout v1-beta Previous HEAD position was 4054321... Added a comment HEAD is now at 1b754e9... Added a default value\n\n## Viendo las etiquetas usando el comando\n\n `tag` 04 Puede ver qué etiquetas están disponibles usando el comando `git tag` command. \n\n > $ git tag v1 v1-beta\n\n## Viendo etiquetas en los Logs 05\n\nTambién puede revisar las etiquetas en el log.\n\n > git hist master --all\n\n > $ git hist master --all * 4054321 2012-03-06 | Added a comment (v1, master) [Jim Weirich] * 1b754e9 2012-03-06 | Added a default value (HEAD, v1-beta) [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [Jim Weirich] * 3cbf83b 2012-03-06 | First Commit [Jim Weirich]\n Podrá observar ambas etiquetas ( `v1` y  `v1-beta` ) enlistadas en la salida del comando log output, a un lado del nombre del branch (  `master` ).  También observe que  `HEAD` denota la versión actual en el check out (la cual es  `v1-beta` al momento).\n\n# lab 14 Deshacer Cambios Locales (antes de staging)\n\n# lab 14 Deshacer Cambios Locales\n\n(antes de staging) \n\n* Aprender a revertir cambios en el directorio de trabajo.\n\n## Hacer Checkout en Master 01\n\nAsegúrese que está en el último Commit en la rama Master antes de proceder.\n\n## Cambie hello.rb 02\n\nAlgunas veces tiene que modificar un archivo en su directorio local y desea revertir lo que ya se le ha hecho Commit. El comando checkout se encargará de eso.\n\nCambie hello.rb para tener un mal comentario.\n\n > # This is a bad comment. We want to revert it. name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\n## Revise el estatus 03\n\n > $ git status # On branch master # Changes not staged for commit: # (use \"git add ...\" to update what will be committed) # (use \"git checkout -- ...\" to discard changes in working directory) # # modified: hello.rb # no changes added to commit (use \"git add\" and/or \"git commit -a\")\n Vemos que el archivo `hello.rb` ha sido modificado, pero no está en el Stage aún. \n\n## Revierta los cambios en el directorio de trabajo 04\n\n Use el comando `checkout` para realizar un checkout de la versión del repositorio del archivo  `hello.rb` . \n\n > git checkout hello.rb\n > git status\n > cat hello.rb\n\n > $ git checkout hello.rb $ git status # On branch master nothing to commit (working directory clean) $ cat hello.rb # Default is \"World\" name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\nEl comando status nos muestra que no hay otros cambios en el directorio de trabajo, y el “mal comentario” ya no forma parte del contenido del archivo.\n\n# lab 15 Deshacer Cambios en Stage (antes de commit)\n\n# lab 15 Deshacer Cambios en Stage\n\n(antes de commit) \n\n* Aprender cómo revertir los cambios que están en área de Stage.\n\n## Cambiar el archivo y poner en Stage el cambio 01\n\n Modificar el archivo `hello.rb` para tener un mal comentario. \n\n > # This is an unwanted but staged comment name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\nY entonces, lo ponemos en Stage.\n\nRevisar el estatus de los cambios no deseados.\n\nLa salida de status muestra que el cambio se ha enviado a Stage y está listo para realizar Commit.\n\n## Restablecer el área de Staging 03\n\nAfortunadamente la salida del comando status nos dice exactamente lo que necesitamos hacer para sacar de Staging el cambio.\n\n > git reset HEAD hello.rb\n\n > $ git reset HEAD hello.rb Unstaged changes after reset: M hello.rb\n El comando `reset` revierte el área de Staging para establecerlo en lo que esté en HEAD. Esto limpia el área de Staging del cambio que habíamos hecho. El comando `reset` (por defecto) no cambia el directorio de trabajo. Así que el directorio de trabajo aún tiene el comentario no deseado en él. Podemos usar el comando  `checkout` visto en el laboratorio previo para quitar el cambio del directorio de trabajo. \n\n## Realizar Checkout 04\n\n > git checkout hello.rb\n > git status\n\nCon esto, nuestro directorio de trabajo está limpio una vez más.\n\n* Aprender a revertir los cambios que se enviaron a Commit en un repositorio local.\n\n## Deshacer Commits 01\n\nAlgunas veces se da cuenta que el cambio que ya está confirmado era incorrecto y desea deshacer ese Commit. Hay varias formas de manejar este asunto, y la manera en que vamos a usar en este laboratorio siempre es segura.\n\nEsencialmente desharemos el Commit al crear un nuevo Commit que retorne el cambio no deseado.\n\n## Cambie el archivo y haga el Commit. 02\n\n Cambie el archivo `hello.rb` con lo siguiente. \n\n > # This is an unwanted but committed change name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\n > git add hello.rb\n > git commit -m \"Oops, we didn't want this commit\"\n\n## Crear y Revertir Commit 03\n\nPara deshacer el cambio confirmado, necesitamos generar un commit que quite los cambios introducidos en nuestro Commit no deseado.\n\n > git revert HEAD\n\nEsto hará aparecer el editor. Puede editar el mensaje por defecto del Commit o dejarlo como está. Guarde y cierre el archivo. Debería ver …\n\n > $ git revert HEAD --no-edit [master 9ad227a] Revert \"Oops, we didn't want this commit\" 1 files changed, 1 insertions(+), 1 deletions(-)\n Debido a que estamos deshaciendo el último Commit que hicimos, podemos usar `HEAD` como el argumento a revertir. Podemos revertir arbitrariamente cualquier Commit en el historial simplemente al especificar su hash. Nota: El parámetro `--no-edit` en la salida puede ser ignorado. Esto es necesario para generar la salida sin abrir el editor. \n\n## Revise el log 04\n\nAl revisar el log nos muestra ambos Commit, el no deseado y el Commit paa revertir los cambios en nuestro repositorio.\n\nEsta técnica funcionará con cualquier commit (aunque puede que tenga que resolver conflictos). Es seguro de usar aún en ramas que están públicamente compartirdas en repositorios remotos.\n\n## A Continuación 05\n\nComo siguiente paso, veremos una técnica que puede ser usada para quitar los Commits más recientes del repositorio público.\n\n* Aprender a quitar los Commits más recientes de una ramificación.\n El comando `revert` de la sección previa es un poderoso comando que nos permite deshacer los efectos de cualquier Commit en el repositorio. Sin embrgo, ambos, el Commit original y el Commit “deshecho” están invisibles en el historial de la ramificación (usando el commando  `git log` . Frecuentemente hacemos un Commit e inmediatamente nos damos cuenta que fue un error. Sería bueno tener un comando “recuperador” que nos permitiera hacer de cuenta que ese commit nunca sucedió. El comando “recuperador” incluso prevendría que el Commit defectuoso se mostrara en el historial que arroja `git log` . Sería como el Commit defectuoso nunca hubera sucedido. \n\n## El comando\n\n `reset` 01 Ya hemos visto el comando `reset` y lo hemos usado para establecer el área de Staging para que fuera consistente con un Commit en especial (usamos el Commit HEAD en nuestro anterior lab). Cuando se realiza un Commit referenciado (por ejemplo, un hash, una ramificación o nombre de etiqueta), el comando `reset` realizará lo siguiente … \n\n* Reescribir la ramificación actual y apuntarlo a un Commit en específico\n * Opcionalmente reestablecer el área de Staging para coincidir con el Commit especificado\n * Opcionalmente reestablecer el directorio de trabajo para coincidir con el Commit especificado\n\n## Revisar nuestro historial 02\n\nHagamos una revisión rápida de nuestro historial de Commits.\n\nVemos que tenemos un Commit “Oops” y “Revert Oops” en los últimos dos Commits hechos en esta ramificación. Vamos a quitarlos usando reset.\n\n## Primero, marquemos esta Ramificación 03\n\nPero antes de quitar los Commits, marquemos el último Commit con una etiqueta, así podremos buscarlo de nuevo.\n\n > git tag oops\n\n## Reestablecer el repositorio a como se encontraba antes de Oops 04\n\nAl ver el historial (arriba), podemos ver que el Commit etiquetado como ‘v1’ es el que se encuentra justo antes del mal comentario. Reestablezcamos el branch a ese punto. Debido a que el Branch está etiquetado , podemos usar el nombre de la etiqueta en el comando reset (si no fue etiquetado, podemos usar su hash).\n\n > git reset --hard v1\n > git hist\n\n > $ git reset --hard v1 HEAD is now at 4054321 Added a comment $ git hist * 4054321 2012-03-06 | Added a comment (HEAD, v1, master) [Jim Weirich] * 1b754e9 2012-03-06 | Added a default value (v1-beta) [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [Jim Weirich] * 3cbf83b 2012-03-06 | First Commit [Jim Weirich]\n Nuestro branch principal ahora apunta al Commit v1 y el commit \"Oops\" y \"Revert Oops commit\" no están más en la rama. El parámetro `--hard` indica que el directorio de trabajo debe ser actualizado para ser consistente con la nueva cabeza del branch. \n\n## Nada se Pierde 05\n\nPero ¿qué les pasó a los malos Commits? Resulta que esos Commits están aún en el repositorio. De hecho, aún podemos referenciarlos. Recuerda que al inicio de este lab etiquetamos el Commit con “oops”. Veamos en todos los Commits.\n\nAquí vemos que los malos Commits no han desaparecido, aún están en el repository. Lo que sucede es que sólo no están listados en el branch principal. Si no los hemos etiquetado, seguirían aún en el repositorio, pero no habría forma de referenciarlos más que usando los valores de hash. Los Commits que no tienen referencia quedan en el repositorio hasta que el sistema ejecuta el software de recolección de basura.\n\n## Peligros del Reset 06\n\nLos Resets en ramificaciones locales son generalmente seguros. Cualquier accidente puede ser recuperado con sólo reestablecerlo al Commit deseado.\n\nSin embargo, si la ramificación está compartido en repositorios remotos, puede confundir a otros usuarios que comparten el branch.\n\n* Quitar la etiqueta \"oops\" (limpeza interna)\n\n## Quitando etiqueta \"oops\" 01\n\nLa etiqueta \"oops\" ha servido para el propósito. Vamos a quitarla y permitir que los Commits a los que hace referencia sean manejados por el recolector de basura.\n\n > git tag -d oops\n > git hist --all\n\n > $ git tag -d oops Deleted tag 'oops' (was 9ad227a) $ git hist --all * 4054321 2012-03-06 | Added a comment (HEAD, v1, master) [] * 1b754e9 2012-03-06 | Added a default value (v1-beta) [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [Jim Weirich] * 3cbf83b 2012-03-06 | First Commit [Jim Weirich]\n\nLa etiqueta \"oops\" ya no se encuentra listada en el repositorio.\n\n* Aprender a enmendar un Commit existente\n\n## Cambie el programa, luego haga Commit 01\n\nAgregue un comentario con el nombre del autor.\n\n > git add hello.rb\n > git commit -m \"Add an author comment\"\n\n## Oops, debimos poner también el Email 02\n\nDespués de hacer el Commit, se dió cuenta que debió incluir el correo electrónico. Actualice el programa hello para incluirlo\n\n## Enmiende el anterior Commit 03\n\nRealmente no queremos un Commit por separado sólo para el email. Vamos a enmendar el anterior Commit para incluir el cambio con la introducción del correo electrónico.\n\n > git add hello.rb\n > git commit --amend -m \"Add an author/email comment\"\n\n > $ git add hello.rb $ git commit --amend -m \"Add an author/email comment\" [master 9c78ad8] Add an author/email comment 1 files changed, 2 insertions(+), 1 deletions(-)\n\n## Revise el Historial 04\n\nPodemos ver que Commit original con sólo el autor ha desaparecido, y es remplazado con el Commit de “autor/email”. Puede alcanzar el mismo efecto reestableciendo el branch al Commit anterior y reenviando el Commit con los nuevos cambios.\n\n* Aprender a mover archivos en el repositorio.\n\n## Mover el archivo hello.rb al directorio lib. 01\n\nVamos a construir la estructura de nuestro repositorio, empezaremos moviendo el programa hello al directorio lib.\n\n > mkdir lib\n > git mv hello.rb lib\n > git status\n\n > $ mkdir lib $ git mv hello.rb lib $ git status # On branch master # Changes to be committed: # (use \"git reset HEAD ...\" to unstage) # # renamed: hello.rb -> lib/hello.rb #\n\nAl usar git para hacer el movimiento, informamos a git de dos cosas:\n\n* Que el archivo\n `hello.rb` ha sido borrado. * Que el archivo\n `lib/hello.rb` ha sido creado. \nEstos bits de información son inmediatamente enviados al área de Stage y están listos para hacer Commit. El comando git status reporta que el archivo ha sido movido.\n\n## Otra manera de mover archivos 02\n\nUna de las cosas bonitas de git es que puede olvidarse del control de versiones hasta el punto en que esté listo de realizar confirmaciones vía Commit. ¿Qué hubiera pasado si usamos los comandos del sistemas operativos para mover el archivo en vez del comando de git?\n\nResulta que el siguiente conjunto de comandos es idéntico a lo que acabamos de hacer. Es un poco de más trabajo, pero el resultado es el mismo.\n\nPudimos haber hecho:\n > mkdir lib\n > mv hello.rb lib\n > git add lib/hello.rb\n > git rm hello.rb\n\n## Realizar Commit del nuevo directorio 03\n\nVamos a hacer el Commit de lo anterior.\n\n > git commit -m \"Moved hello.rb to lib\"\n\n* Agregar otro archivo a nuestro repositorio.\n\n## Ahora agregaremos un Rakefile 01\n\nVamos a agregar un Rakefile a nuestro repositorio. El siguiente archivo lo hará correctamente.\n\n > #!/usr/bin/ruby -wKU task :default => :run task :run do require './lib/hello' end\n\nAgregar y realizar Commit de los cambios.\n\n > git add Rakefile\n > git commit -m \"Added a Rakefile.\"\n\nAhora debería poder usar el Rake para ejecutar su programa hello.\n\n > rake\n\n > $ rake Hello, World!\n\n# lab 22 Al Interior de Git: El directorio .git/h1# lab 22 Al Interior de Git:\n\nEl directorio .git/h1* Aprender sobre la estructura de el directorio\n `.git` . \n\n## El Directorio\n\n `.git` 01 \nEs tiempo de explorar un poco. Primero, iniciando desde la raíz del directorio de su proyecto …\n\n > ls -C .git\n\n > $ ls -C .git COMMIT_EDITMSG config index objects HEAD description info refs ORIG_HEAD hooks logs\n\nÉste es el directorio mágico donde son almacenadas todas las “cosas” de git. Echemos un vistazo en el directorio de objetos\n\n## El Almacenamiento de Objetos 02\n\n > ls -C .git/objects\n\n > $ ls -C .git/objects 09 24 30 43 69 78 9c b8 e4 pack 11 27 3c 49 6b 97 af c4 e7 1b 28 40 59 76 9a b5 d2 info\n\nDebería ver un monton de directorios con nombres de dos letras. Los nombres de los directorios son las dos primeras letras del hash sha1 del objeto almacenado en git.\n\n## A Profundidad en el Almacenamiento de Objetos 03\n\n > ls -C .git/objects/ $ ls -C .git/objects/09 6b74c56bfc6b40e754fc0725b8c70b2038b91e 9fb6f9d3a104feb32fcac22354c4d0e8a182c1\n\nMire en alguno de los directorios de dos letras. Verá algunos archivos con nombres de 38 caracteres. Estos son los archivos que contienen los objetos almacenados en git. Estos archivos están compresos y codificados, así que no será de mucha ayuda el mirar directamente en el contenido, pero daremos un vistazo más a detalle.\n\n## Archivo de Configuración 04\n\n > cat .git/config\n\n > $ cat .git/config [core] repositoryformatversion = 0 filemode = true bare = false logallrefupdates = true ignorecase = true [user] name =  email = jim (at) edgecase.com\n Este es el archivo de configuración específico del proyecto. Las entradas en la configuración serán sobrepuestas con las configuraciones que se encuentran en el archivo `.gitconfig` en su directorio raíz, al menos para este proyecto. \n\n## Ramas y Etiquetas 05\n\n > ls .git/refs\n > ls .git/refs/heads\n > ls .git/refs/tags\n > cat .git/refs/tags/v1\n\n > $ ls .git/refs heads tags $ ls .git/refs/heads master $ ls .git/refs/tags v1 v1-beta $ cat .git/refs/tags/v1 40543214b69016a1f079a0d95ff88cc7421e9b54\n Podría reconocer los archivos en el subdirectorio \"tags\". Cada archivo corresponde a una etiqueta que se creó anteriormente con el comando `git tag` . Su contenido es sólo el hash del Commit atado a la etiqueta. \nAlgo similar sucede con los directorios \"heads\", pero ellos son usado con las ramificaciones en vez de las etiquetas. En este momento sólo tenemos una rama, así que veremos \"master\" en este directorio.\n\n## El Archivo HEAD 06\n\n > cat .git/HEAD\n\n > $ cat .git/HEAD ref: refs/heads/master\n\nEl archivo HEAD contiene una referencia a la ramificación actual. Esto debería ser una referencia a \"master\" en este punto.\n\n# lab 23 Al Interior de Git: Directorio de trabajo con Objetos de Git\n\n# lab 23 Al Interior de Git:\n\nDirectorio de trabajo con Objetos de Git \n\n* Explorar la estructura del almacenamiento de objetos.\n * Aprender a usar los hash SHA1 para encontrar contenido en el repositorio.\n\nAhora vamos a usar algunas herramientas para probar los objetos de git directamente.\n\n## Encontrando el último Commit 01\n\n > git hist --max-count=1\n\nEsto debería mostrar el último Commit hecho en el repositorio. El hash SHA1 en su sistema es seguramente diferente al mío, pero verá algo como esto:\n\n > $ git hist --max-count=1 * 76ba0a7 2012-03-06 | Added a Rakefile. (HEAD, master) [Jim Weirich]\n\n## Extrayendo el último Commit 02\n\nUsando el hash SHA1 del listado anterior …\n\n > git cat-file -t \n > git cat-file -p  $ git cat-file -t 76ba0a7 commit $ git cat-file -p 76ba0a7 tree 096b74c56bfc6b40e754fc0725b8c70b2038b91e parent b8f15c35ac4e42485773fec06e7155203a16c986 author   1331068328 -0500 committer   1331068328 -0500 Added a Rakefile.\n NOTA: Si definió los alias ‘type’ y ‘dump’ en el laboratorio de alias, entonces podrá escribir `git type` y  `git dump` en vez de el comando más largo cat-file (el cuál nunca puedo recordar). \nEste es el vaciado de el objeto Commit que está en el encabezado de la rama \"master\". Se parece mucho al objeto Commit de la presentación anterior.\n\n## Buscando el Árbol 03\n\nPodemos vaciar el árbol referenciado en el Commit. Debería ser una descripción de los archivos de más alto nivel en nuestro proyecto (para ese Commit). Use el valor del hash SHA1 de la propiedad “tree” listado arriba.\n\n > git cat-file -p  $ git cat-file -p 096b74c 100644 blob 28e0e9d6ea7e25f35ec64a43f569b550e8386f90 Rakefile 040000 tree e46f374f5b36c6f02fb3e9e922b79044f754d795 lib\n\nSí, veo el Rakefile y el directorio lib.\n\n## Volcando el directorio lib 04\n\n > git cat-file -p  $ git cat-file -p e46f374 100644 blob c45f26b6fdc7db6ba779fc4c385d9d24fc12cf72 hello.rb\n Aquí está el archivo `hello.rb` . \n\n## Volcando el archivo\n\n `hello.rb` 05 \n\n > git cat-file -p  $ git cat-file -p c45f26b # Default is World # Author:  () name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n\nAquí lo tiene. Hemos volcado los objetos Commit, tree y blob directamente desde el repositorio git. Es todo lo que hay: blobs, árboles y commits.\n\n## Explore usted mismo 06\n\nExplore por su cuenta el repositorio git manualmente. Vea si puede encontrar el archivo origina hello.rb desde el primer Commit siguiendo manualmente las referencias de los hash SHA1 iniciando desde el último Commit.\n\n* Aprender a crear una ramificación local en un repositorio.\n\nEs tiempo de hacer una reescritura mayor de la funcionalidad del programa hello world. Debido a que esto tomara un poco de tiempo, queremos poner estos cambios en una ramificación separada para aislarlo de los cambios en \"master\".\n\n## Crear una Ramificación 01\n\nLlamemos a nuestra nueva rama ‘greet’.\n\n > git checkout -b greet\n > git status\n NOTA:\n\n```\ngit checkout -b \n```\n\nes un atajo para \n\n```\ngit branch \n```\n\nseguido de \n\n```\ngit checkout \n```\n\n. \nObserve que el comando git status reporta que está en la rama ‘greet’.\n\n## Cambios para Greet: Agregar una clase Greeter. 02\n\n# Archivo: lib/greeter.rb\n\n > class Greeter def initialize(who) @who = who end def greet \"Hello, #{@who}\" end end\n\n > git add lib/greeter.rb\n > git commit -m \"Added greeter class\"\n\n## Cambios para Greet: Modificar el archivo principal 03\n\nActualice el archivo hello.rb para hacer uso de greeter.\n\n > require 'greeter' # Default is World name = ARGV.first || \"World\" greeter = Greeter.new(name) puts greeter.greet\n\n > git add lib/hello.rb\n > git commit -m \"Hello uses Greeter\"\n\n## Cambios para Greet: Actualizar el Rakefile 04\n\nActualice el Rakefile para hacer uso de un proceso externo de ruby.\n\n > #!/usr/bin/ruby -wKU task :default => :run task :run do ruby '-Ilib', 'lib/hello.rb' end\n\n > git add Rakefile\n > git commit -m \"Updated Rakefile\"\n\n## A continuación 05\n\nAhora tenemos una ramificación llamada greet con tres Commits en él. A continuación aprenderemos a navegar y cambiarnos entre ramas.\n\n* Aprender a navegar entre las distintas ramificaciones de un repositorio.\n\nAhora tenemos dos ramificaciones en nuestro proyecto:\n\n## Cambie a la Ramificación \"Master\" 01\n\n Just use the `git checkout` command to switch between branches. \n\n > git checkout master\n > cat lib/hello.rb\n\n > $ git checkout master Switched to branch 'master' $ cat lib/hello.rb # Default is World # Author:  () name = ARGV.first || \"World\" puts \"Hello, #{name}!\"\n Ahora se encuentra en la ramificación principal. Puede saberlo porque el archivo hello.rb no usa la clase `Greeter` . \n\n## Cambiar a la Ramificación \"Greet\". 02\n\n > git checkout greet\n > cat lib/hello.rb\n\n > $ git checkout greet Switched to branch 'greet' $ cat lib/hello.rb require 'greeter' # Default is World name = ARGV.first || \"World\" greeter = Greeter.new(name) puts greeter.greet\n El contenido de `lib/hello.rb` confirma que estamos de regreso a la ramificación greet.\n\n* Aprender a trabajar con múltiples Ramificaciones con diferentes (y posiblemente conflictivos) cambios.\n\nMientras estaba cambiando la rama \"greet\", alguien más decidió actualizar la ramificación \"master\". Agregó un archivo README.\n\n## Cambiar a la ramificación \"master\". 01\n\n## Cree el archivo README. 02\n\n## Haga Commit del archivo README en master. 03\n\n > git add README\n > git commit -m \"Added README\"\n\n* Aprender a ver las ramificaciones divergentes en el repositorio.\n\n## Ver la Ramificación Actual 01\n\nAhora tenemos dos ramificaciones divergentes en el repositorio. Use el siguiente comando de log para ver las ramas y cómo divergen.\n\n > $ git hist --all * e2257cb 2012-03-06 | Updated Rakefile (greet) [Jim Weirich] * a93f079 2012-03-06 | Hello uses Greeter [Jim Weirich] * 4b9457a 2012-03-06 | Added greeter class [Jim Weirich] | * 3ce0095 2012-03-06 | Added README (HEAD, master) [Jim Weirich] |/ * 76ba0a7 2012-03-06 | Added a Rakefile. [Jim Weirich] * b8f15c3 2012-03-06 | Moved hello.rb to lib [Jim Weirich] * 9c78ad8 2012-03-06 | Add an author/email comment [Jim Weirich] * 4054321 2012-03-06 | Added a comment (v1) [Jim Weirich] * 1b754e9 2012-03-06 | Added a default value (v1-beta) [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [Jim Weirich] * 3cbf83b 2012-03-06 | First Commit [Jim Weirich]\n Aquí está nuestro primera oportunidad para ver en acción la opción `--graph` del  `git hist` , esto causa que se dibuje en pantalla el arbol de Commit usando unos sencillos caracteres ASCII. Ahora podemos ver que tenemos dos ramificaciones (greet y master), y que la ramificación principal es el actual HEAD (encabezamiento). El antecesor común de ambas ramas es el “Added a Rakefile”. La bandera `--all` nos asegura que veremos todas las ramificaciones. El valor por defecto es mostrar sólo la gráfica de la rama actual.\n\n* Aprender a fusionar dos ramificaciones divergentes para llevar los cambios de nuevo a una sola rama\n\n## Fusionar las ramificaciones 01\n\nLa fusión junta los cambios de dos ramificaciones. Regresemos a la rama \"greet\" y fusionemosla con la rama \"master\".\n\n > git checkout greet\n > git merge master\n > git hist --all\n\nAl fusionar \"master\" con \"greet\" periódicamente puede hacer que los cambios en greet sean más compatibles con la línea principal de desarrollo (\"master\").\n\nSin embargo, esto produce unas feas gráficas de Commits. Más adelante veremos la opción de rebasar en vez de fusionar.\n\n## A continuación 02\n\nPero antes, ¿Qué tal si los cambios en master tienen conflicto con los cambios en greet?\n\n* Crear un cambio conflictivo en la ramificación principal.\n\n## Cambie a la ramificación principal y cree un conflicto 01\n\nCambiese a la ramificación principal y haga este cambio:\n\n > puts \"What's your name\" my_name = gets.strip puts \"Hello, #{my_name}!\"\n\n > git add lib/hello.rb\n > git commit -m \"Made interactive\"\n\n## Vea la ramificación 02\n\nLa ramificación principal en su Commit “Added README” ha sido fusionado con la rama \"greet\", pero hay un Commit adicional en Master que no ha sido fusionado con \"greet\".\n\n## A Continuación 03\n\nEl último cambio en Master se conflictúa con algunos cambios existentes en \"greet\". A continuación resolveremos este problema.\n\n* Aprender a manejar conflictos en una fusión\n\n## Fusionar \"master\" a \"greet\" 01\n\nRegrese a la rama \"greet\" e intente fusionar el nuevo \"master\".\n\n > $ git checkout greet Switched to branch 'greet' $ git merge master Auto-merging lib/hello.rb CONFLICT (content): Merge conflict in lib/hello.rb Automatic merge failed; fix conflicts and then commit the result.\n\nSi abre lib/hello.rb, podrá ver:\n\n > <<<<<<< HEAD require 'greeter' # Default is World name = ARGV.first || \"World\" greeter = Greeter.new(name) puts greeter.greet ======= # Default is World puts \"What's your name\" my_name = gets.strip puts \"Hello, #{my_name}!\" >>>>>>> master\n\nLa primera sección es la versión en el encabezamiento de la ramificación actual (greet). La segunda sección es la versión en la rama \"master\".\n\n## Corija el Conflicto 02\n\n Necesita resolver el conflicto manualmente. Modifique `lib/hello.rb` para tener lo siguiente: \n\n > require 'greeter' puts \"What's your name\" my_name = gets.strip greeter = Greeter.new(my_name) puts greeter.greet\n\n## Commit the Conflict Resolution 03\n\n > git add lib/hello.rb\n > git commit -m \"Merged master fixed conflict.\"\n\n > $ git add lib/hello.rb $ git commit -m \"Merged master fixed conflict.\" [greet 3165f66] Merged master fixed conflict.\n\n## Fusión Avanzada 04\n\ngit no provee una herramienta gráfica para fusionar, pero funcionará correctamente con cualquier herramienta de terceros que desee utilizar. Vea http://onestepback.org/index.cgi/Tech/Git/UsingP4MergeWithGit.red para una descripción de cómo utilizar \"Perforce\", una herramienta para fusión con git.\n\n* Aprender la diferencia entre Cambio de Base (Rebasing) y Fusión (Merging).\n\nExploremos la diferencia entre Cambio de Base y Fusión. Para lograrlo necesitamos regresar el repositorio al momento antes de la primera fusión, después de eso rehacer los mismos pasos, pero usando el Cambio de Base en vez de la Fusión.\n Haremos uso de el comando `reset` para cambiar la ramificación en el historial.\n\n* Reestablecer la ramificación \"greet\" al punto anterior de la primera fusión.\n\nVamos a regresar en el tiempo a la ramificación \"greet\" en el punto antes de que lo fusionaramos. Podemos reestablecer una ramificación en el Commit que deseemos. Esto es, esencialmente, modificiar el apuntador de la ramificación a cualquier punto dentro del arbol de Commits.\n\nEn este caso deseamos regresar la ramificación \"greet\" en el punto antes de la fusión con \"master\". Necesitamos encontrar el último Commit antes de la fusión.\n\n > git checkout greet\n > git hist\n\nEsto es un poco difícil de leer, pero observando los datos podemos ver que el Commit “Updated Rakefile” fue el último antes de fusionaramos la ramificación \"greet\". Vamos a reestablecer la ramificación \"greet\" a ese Commit.\n\n > git reset --hard  $ git reset --hard e2257cb HEAD is now at e2257cb Updated Rakefile\n\n## Revise la ramificación. 02\n\nBusque en el log la ramificación \"greet\". Ya no tenemos los Commits de la fusión en el historial.\n\n* Reestablecer la ramificación principal al punto antes del Commit conflictivo.\n\nCuando añadimos el modo interactivo a la ramificación principal, hicimos un cambio que tenía conflictos con los cambios en la ramificación greet. Vamos a regresar la ramificación principal al punto antes del cambio conflictivo. Esto nos permite demostrar el Cambio de Base sin preocuparnos sobre los conflictos.\n\n > git checkout master\n > git hist\n\nEl Commit ‘Added README’ está justo antes del modo interactivo con conflicto. Reestableceremos la ramificación principal a ese Commit.\n\n > git reset --hard \n > git hist --all\n\nRevise el log. Se debe mostrar justo como estaba el repositorio antes de que hicieramos la fusión.\n\n* Usar el comando rebase en vez del comando merge.\n\nRegresamos en el tiempo antes de la primera fusión y deseamos tener los cambios de la ramificación principal en greet.\n\nEsta vez usaremos el comando rebase en vez del comando merge para traer los cambios desde la ramificación principal.\n\n > git checkout greet\n > git rebase master\n > git hist\n\n > $ go greet Switched to branch 'greet' $ $ git rebase master First, rewinding head to replay your work on top of it... Applying: added Greeter class Applying: hello uses Greeter Applying: updated Rakefile $ $ git hist * e1399d1 2012-03-06 | Updated Rakefile (HEAD, greet) [Jim Weirich] * 183c6ad 2012-03-06 | Hello uses Greeter [Jim Weirich] * 297678c 2012-03-06 | Added greeter class [Jim Weirich] * 3ce0095 2012-03-06 | Added README (master) [Jim Weirich] * 76ba0a7 2012-03-06 | Added a Rakefile. [Jim Weirich] * b8f15c3 2012-03-06 | Moved hello.rb to lib [Jim Weirich] * 9c78ad8 2012-03-06 | Add an author/email comment [Jim Weirich] * 4054321 2012-03-06 | Added a comment (v1) [Jim Weirich] * 1b754e9 2012-03-06 | Added a default value (v1-beta) [Jim Weirich] * 3053491 2012-03-06 | Using ARGV [] * 3cbf83b 2012-03-06 | First Commit []\n\n## Merge VS Rebase 01\n\nEl resultado final del Cambio de Base es muy similar a la Fusión. La ramificación \"greet\" ahora contiene todos sus cambios, así como los cambios en la ramificación principal. Sin embargo, el árbol de Commits es un poco diferente. El árbol de Commits para la ramificación \"greet\" ha sido reescrito para la ramificación principal forme parte del historial de Commit. Esto deja la cadena de commits lineal y mucho má fácil de leer.\n\n## ¿Cuándo usar el comando Rebase, cuándo Merge? 02\n\nNo use Rebase\n\n* Si la ramificación es pública y compartida con otros. Reescribir ramificaciones públicas tiende a hacer enojar a otros miembros del equipo.\n * Cuando la exactitud del historial es importante (debido a que rebase reescribe el historial de Commits).\n\nDada las directrices anteriores, yo tiendo a usar el coamdno rebase para ramificaciones locales de corta vida, y el comando merge para ramificaciones en repositorios públicos.\n\n* Hemos mantenido nuestra ramificación \"greet\" al día con la principal (vía rebase), ahora vamos a fusionar los cambios en \"greet\" con la ramificación principal.\n\n## Fusionar greet en la ramificación principal 01\n\n > $ git checkout master Switched to branch 'master' $ $ git merge greet Updating 3ce0095..e1399d1 Fast-forward Rakefile | 2 +- lib/greeter.rb | 8 ++++++++ lib/hello.rb | 6 ++++-- 3 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 lib/greeter.rb\n\nDebido a que el encabezado de la ramificación principal es el antecesor director del encabezado en \"greet\", git puede hacer una fusión \"hacia adelante\". Cuando adelantamos (fast-forwarding), el apuntador de la ramificación simplemente se mueve hacia adelante para apuntar al mismo commit que la ramificación \"greet\".\n\nNunca habrá conflictos cuando se realiza una fusión \"hacia adelante\".\n\n## Revisar los logs 02\n\nAhora las ramificaciones \"greet\" y \"master\" son idénticas.\n\nHasta este punto hemos trabajado con un único repositorio git. Sin embargo, git es excelente para trabajar con múltiples repositorios. Estos repositorios extra pueden ser almacenados localmente, o quizás ser accedidos a través de una conexión de red.\n\nEn la siguiente sección crearemos un nuevo repositorio llamado “cloned_hello”. Mostraremos cómo mover los cambios desde un repositorio a otro, y también a manejar conflictos cuando surjan problemas entre los dos repositorios.\n\nPor ahora, estaremos trabajando con repositorios locales (por ejemplo, repositorios almacenados en su disco duro local), sin embargo, muchas de las cosas aprendidas en esta sección aplicarán tanto para trabajo local como a remoto a través de la red.\n\nNOTA: Vamos a hacer cambios en ambas copias de nuestros repositorios. Asegúrese de poner atención en cuál repositorio está en cada paso de los siguientes laboratorios.\n\n* Aprender a hacer copias de repositorios.\n\n## Vaya al directorio de trabajo 01\n\nVaya al directorio de trabajo y haga un clon de nuestro repositorio hello.\n\n > cd ..\n > pwd\n > ls\n\nNOTA: En nuestro directorio de trabajo.\n\n > $ cd .. $ pwd /Users/jerrynummi/Projects/edgecase/git_immersion/auto $ ls hello\n\nEn este punto debe estar en su directorio de trabajo. Debe haber un único repositorio llamado “hello”.\n\n## Crear un clon del repositorio hello 02\n\nVamos a clonar el repositorio.\n\n > git clone hello cloned_hello\n > ls\n\n > $ git clone hello cloned_hello Cloning into 'cloned_hello'... done. $ ls cloned_hello hello\n\nAhora debe haber dos repositorios en el directorio de trabajo: el repositorio “hello” original y el nuevo repositorio clonado “cloned_hello”.\n\n* Aprender sobre ramificaciones en repositorios remotos.\n\n## Vea el repositorio clonado 01\n\nVamos a observar el repositorio clonado.\n\n > cd cloned_hello\n > ls\n\n > $ cd cloned_hello $ ls README Rakefile lib\n Debe ver una lista de todos los archivos en el directorio nivel superior del repositorio original ( `README` ,  `Rakefile` y  `lib` ). \n\n## Revise el Historial del Repositorio 02\n\nAhora debe ver un listado de todos los Commits en el nuevo repositorio, y este debería coincidir (más o menos) con el historial de Commits en el repositorio original. La única diferencia debería ser los nombre de las ramificaciones.\n\n## Ramificaciones Remotas 03\n\nDebe ver una ramificación master (junto con HEAD) en el listado del historial. Pero tambien tendrá una cantidad de ramificaciones con nombre extraño (origin/master, origin/greet y origin/HEAD). Hablaremos de esto en un momento más.\n\n* Aprender sobre los nombres de repositorios remotos.\n\n > git remote\n\n > $ git remote origin\n\nVemos que el repositorio clonado sabe sobre un repositorio llamado \"origin\". Veremos si podemos obtener más información sobre origin:\n\n > git remote show origin\n\n > $ git remote show origin * remote origin Fetch URL: /Users/jerrynummi/Projects/edgecase/git_immersion/auto/hello Push URL: /Users/jerrynummi/Projects/edgecase/git_immersion/auto/hello HEAD branch (remote HEAD is ambiguous, may be one of the following): greet master Remote branches: greet tracked master tracked Local branch configured for 'git pull': master merges with remote master Local ref configured for 'git push': master pushes to master (up to date)\n\nAhora vemos que el repositorio remoto “origin” es simplemente el repositorio original hello. Los repositorios remotos viven típicamente en una máquina separada, posiblemente en un servidor centralizado. Como podemos ver aquí, sin embargo, también pueden apuntar a repositorios en la misma máquina. No hay nada particularmente especial sobre el nombre “origin”, pero la convención generalizada es usar el nombre “origin” para el repositorio principal centralizado.\n\n* Aprender sobre ramificaciones locales VS remotas\n\nVeamos las ramificaciones disponibles en el repositorio clonado.\n\n > git branch\n\n > $ git branch * master\n\nEsto es, sólo la ramificación principal está en el listado. ¿Dónde está la ramificación \"greet\"? El comando git branch sólo lista la ramificación local por defecto.\n\n## Listar Ramificaciones Remotas 01\n\nIntente esto para ver todas las ramificaciones:\n\n > git branch -a\n\n > $ git branch -a * master remotes/origin/HEAD -> origin/master remotes/origin/greet remotes/origin/master\n\nGit tiene todos los Commits desde el repositorio original, pero las ramificaciones en el repositorio remoto no son tratadas como locales aquí. Si deseamos nuestra ramificación greet, tenemos que crearla por nosotros mismos. Veremos cómo hacerlo en unos minutos.\n\n* Realizar algunos cambios en el repositorio original así podemos tratar de enviar los cambios remotamente.\n\n## Haga un cambio en el repositorio original hello 01\n\n > cd ../hello\n > # (Debería estar en el repositorio hello original)\n\nNOTA: En el repositorio hello\n\nHaga el siguiente cambio a README:\n\nAhora agregue y realice Commit de esto cambios\n\n > git add README\n > git commit -m \"Changed README in original repo\"\n\n## Continuando 02\n\nEl repositorio original ahora tiene cambios posteriores que no están en la versión clonada. A continuación enviaremos esos cambios hacia el repositorio clonado.\n\n* Aprender como recibir cambios de un repositorio remoto.\n\n > cd ../cloned_hello\n > git fetch\n > git hist --all\n\nNOTA: En el repositorio cloned_hello\n\nEn este punto el repositorio tiene todos los Commits del repositorio original, pero no están integrados en las ramificaciones locales del repositorio clonado.\n\nEncuentre el Commit “Changed README in original repo” en el repositorio arriba mostrado. Note que el Commit incluye “origin/master” y “origin/HEAD”.\n\nAhora mire en el Commit “Updated Rakefile”. Verá que la ramificación principal apuna a éste Commit, no al nuevo commit que acabamos de recibir.\n\nEl resultado de ésto es que el comando “git fetch” traerá los nuevos commits desde el repositorio remoto, pero no los fusionará en las ramificaciones locales.\n\n## Revise el archivo README 01\n\nPodemos demostrar que el README está sin cambios.\n\n¿Puede verlo?, no hay cambios.\n\n* Aprender a obtener los cambios (vía comando pull) en la ramificación y directorio de trabajo actual.\n\n## Fusionar los cambios recibidos en el repositorio principal (master) 01\n\n > git merge origin/master\n\n > $ git merge origin/master Updating e1399d1..e18658c Fast-forward README | 1 + 1 files changed, 1 insertions(+), 0 deletions(-)\n\n## Revise el archivo README una vez más 02\n\nDebería pode ver los cambio.\n\nExisten cambios. Incluso aunque “git fetch” no fusione los cambios, aún podemos fusionar manualmente los cambios del repositorio remoto.\n\nVeremos una combinación del proceso de fetch y merge en un sólo comando.\n\n* Aprender que\n `git pull` es equivalente a  `git fetch` seguido de  `git merge` . \n\nNo vamos a ir por el proceso completo de crear otro cambio y recibirlo remotamente de nuevo, pero sí saber que haciendo lo siguiente:\n > git pull\n\nEs equivalente a los dos pasos vistos anteriormente:\n > git fetch\n > git merge origin/master\n\n* Aprender a agregar una ramificación local que rastree una ramificación remota.\n\nLas ramificaciones que inician con remotes/origin son ramificaciones de un repositorio original. Note que no tiene una ramificación llamada \"greet\", pero es conocido que el repositorio original sí la tiene.\n\n## Agregue una ramificación loal que haga rastreo a una ramificación remota. 01\n\n > git branch --track greet origin/greet\n > git branch -a\n > git hist --max-count=2\n\n > $ git branch --track greet origin/greet Branch greet set up to track remote branch greet from origin. $ git branch -a greet * master remotes/origin/HEAD -> origin/master remotes/origin/greet remotes/origin/master $ git hist --max-count=2 * e18658c 2012-03-06 | Changed README in original repo (HEAD, origin/master, origin/HEAD, master) [Jim Weirich] * e1399d1 2012-03-06 | Updated Rakefile (origin/greet, greet) [Jim Weirich]\n\nAhora podemos ver la ramificación \"greet\" en la lista de ramificaciones del comando log.\n\n* Aprender cómo crear un repositorio escueto.\n\nLos repositorios escuetos (sin directorio de trabajo) son generalmente usados para compartir ).\n\n## Crear un repositorio escueto. 01\n\n > cd ..\n > git clone --bare hello hello.git\n > ls hello.git\n\nNOTA: En el directorio de trabajo\n\n > $ git clone --bare hello hello.git Cloning into bare repository 'hello.git'... done. $ ls hello.git HEAD config description hooks info objects packed-refs refs\n\nLa convención generalmente aceptada es que los repositorios terminados en ‘.git’ son repositorios escuetos. Podemos ver que no hay un directorio de trabajo en el repositorio hello.git.\n\n* Agregar el repositorio escueto como uno remoto en nuestro repositorio original.\n\nAgreguemos el repositorio hello.git a nuestro repositorio original.\n\n > cd hello\n > git remote add shared ../hello.git\n\nNOTA: En el repositorio .\n\n* Aprender a enviar cambios a un repositorio remoto.\n\nDebido a que los repositorios escuetos son usualmente compartidos en algún tipo de servidor de red, es usualmente difícil hacer un cambio de directorio en el repositorio y recibir cambios, así que necesitamos enviar nuestros cambios desde otro repositorio.\n\nIniciemos creando un cambio a ser enviado remotamente. Edite el archivo README y realice un Commit con él.\n\n > This is the Hello World example from the git tutorial. (Changed in the original and pushed to shared)\n\n > git checkout master\n > git add README\n > git commit -m \"Added shared comment to readme\"\n\nAhora envíe el cambio al repositorio remoto.\n\n > git push shared master\n\nshared es el nombre del repositorio que está recibiendo los cambios que estamos enviados. (Recuerde, lo agregamos como repositorio remoto en laboratorio previo.)\n\n > $ git push shared master To ../hello.git e18658c..e4b00d1 master -> master\n\nNOTA: Tenemos que nombrar explícitamente la ramificación principal que está recibiendo el cambio remoto. Es posible configurarlo automáticamente, pero en mi caso nunca recuerdo el comando para hacerlo. Revise la documentación de “Git Remote Branch” para una fácil administración de ramificaciones remotas.\n\n* Aprender a recibir cambios desde un repositorio compartido.\n\nPase por el repositorio clonado y reciba los cambios que acabamos de enviar al repositorio compartido.\n\n > cd ../cloned_hello\n\nNOTA: En el repositorio cloned_hello.\n\nContinúe con …\n\n > git remote add shared ../hello.git\n > git branch --track shared master\n > git pull shared master\n > cat README\n\n* Aprender a configurar un servidor git para compartir repositorios.\n\nTHay muchas formas para compartir un repositorio git en la red. Aquí está la manera rápida y sucia.\n\n## Iniciar el servidor git 01\n\n > # (Desde el directorio de trabajo)\n > git daemon --verbose --export-all --base-path=.\n\nAhora, desde una ventana de terminal por separado, vaya al directorio de trabajo.\n\n > # (Desde el directorio de trabajo)\n > git clone git://localhost/hello.git network_hello\n > cd network_hello\n > ls\n\nDeberá ver una copia del proyecto hello.\n\n## Enviando cambios al Demonio Git 02\n\n Si desea enviar los cambios al repositorio git, agregue el parámetro\n\n```\n--enable=receive-pack\n```\n\nal comando del demonio git. Tenga cuidado porque aún no hay autentificación en este servidor, cualquiera podría envíar cambios a su repositorio.\n\n* Aprender a compartir repositorio a través del WIFI.\n\nVea si su vecino está ejecutando un demonio git. Intercambie direcciones IP y vea si puede enviar cambios entre sus repositorios.\n\nNOTA: El paquete gitjour es realmente útil al estar compartiendo repositorios.\n\nAquí están algunos tópicos que podría desar investigar por su cuenta:\n\n* Revertir cambios realizados\n * Final de Línea en diversos sistemas operativos\n * Servidores Remotos\n * Protocolos\n * Configuración SSH\n * Administración de Ramificaciones Remotas\n * Encontrando Commits con Bugs (git bisect)\n * Flujos de trabajo\n * Herramientas gráficas (gitx, gitk, magit)\n * Trabajando con GitHub"}}},{"rowIdx":448,"cells":{"project":{"kind":"string","value":"djangogrpcframework"},"source":{"kind":"string","value":"readthedoc"},"language":{"kind":"string","value":"Python"},"content":{"kind":"string","value":"django-grpc-framework 0.2 documentation\n\nDjango gRPC Framework[¶](#django-grpc-framework)\n===\n\nDjango gRPC framework is a toolkit for building gRPC services with Django.\nOfficially we only support proto3.\n\nUser’s Guide[¶](#user-s-guide)\n---\n\nThis part of the documentation begins with installation, followed by more instructions for building services.\n\n### Installation[¶](#installation)\n\n#### Requirements[¶](#requirements)\n\nWe requires the following:\n\n* Python (3.6, 3.7, 3.8)\n* Django (2.2, 3.0)\n* Django REST Framework (3.10.x, 3.11.x)\n* gRPC\n* gRPC tools\n* proto3\n\n#### virtualenv[¶](#virtualenv)\n\nVirtualenv might be something you want to use for development! let’s create one working environment:\n```\n$ mkdir myproject\n$ cd myproject\n$ python3 -m venv env\n$ source env/bin/activate\n```\nIt is time to get the django grpc framework:\n```\n$ pip install djangogrpcframework\n$ pip install django\n$ pip install djangorestframework\n$ pip install grpcio\n$ pip install grpcio-tools\n```\n#### System Wide[¶](#system-wide)\n\nInstall it for all users on the system:\n```\n$ sudo pip install djangogrpcframework\n```\n#### Development Version[¶](#development-version)\n\nTry the latest version:\n```\n$ source env/bin/activate\n$ git clone https://github.com/fengsp/django-grpc-framework.git\n$ cd django-grpc-framework\n$ python setup.py develop\n```\n### Quickstart[¶](#quickstart)\n\nWe’re going to create a simple service to allow clients to retrieve and edit the users in the system.\n\n#### Project setup[¶](#project-setup)\n\nCreate a new Django project named `quickstart`, then start a new app called\n`account`:\n```\n# Create a virtual environment python3 -m venv env source env/bin/activate\n# Install Django and Django gRPC framework pip install django pip install djangorestframework pip install djangogrpcframework pip install grpcio pip install grpcio-tools\n# Create a new project and a new application django-admin startproject quickstart cd quickstart django-admin startapp account\n```\nNow sync the database:\n```\npython manage.py migrate\n```\n#### Update settings[¶](#update-settings)\n\nAdd `django_grpc_framework` to `INSTALLED_APPS`, settings module is in\n`quickstart/settings.py`:\n```\nINSTALLED_APPS = [\n    ...\n    'django_grpc_framework',\n]\n```\n#### Defining protos[¶](#defining-protos)\n\nOur first step is to define the gRPC service and messages, create a file\n`quickstart/account.proto` next to `quickstart/manage.py`:\n```\nsyntax = \"proto3\";\n\npackage account;\n\nimport \"google/protobuf/empty.proto\";\n\nservice UserController {\n    rpc List(UserListRequest) returns (stream User) {}\n    rpc Create(User) returns (User) {}\n    rpc Retrieve(UserRetrieveRequest) returns (User) {}\n    rpc Update(User) returns (User) {}\n    rpc Destroy(User) returns (google.protobuf.Empty) {}\n}\n\nmessage User {\n    int32 id = 1;\n    string username = 2;\n    string email = 3;\n    repeated int32 groups = 4;\n}\n\nmessage UserListRequest {\n}\n\nmessage UserRetrieveRequest {\n    int32 id = 1;\n}\n```\nOr you can generate it automatically based on `User` model:\n```\npython manage.py generateproto --model django.contrib.auth.models.User --fields id,username,email,groups --file account.proto\n```\nNext we need to generate gRPC code, from the `quickstart` directory, run:\n```\npython -m grpc_tools.protoc --proto_path=./ --python_out=./ --grpc_python_out=./ ./account.proto\n```\n#### Writing serializers[¶](#writing-serializers)\n\nThen we’re going to define a serializer, let’s create a new module named\n`account/serializers.py`:\n```\nfrom django.contrib.auth.models import User from django_grpc_framework import proto_serializers import account_pb2\n\nclass UserProtoSerializer(proto_serializers.ModelProtoSerializer):\n    class Meta:\n        model = User\n        proto_class = account_pb2.User\n        fields = ['id', 'username', 'email', 'groups']\n```\n#### Writing services[¶](#writing-services)\n\nNow we’d write some a service, create `account/services.py`:\n```\nfrom django.contrib.auth.models import User from django_grpc_framework import generics from account.serializers import UserProtoSerializer\n\nclass UserService(generics.ModelService):\n    \"\"\"\n gRPC service that allows users to be retrieved or updated.\n \"\"\"\n    queryset = User.objects.all().order_by('-date_joined')\n    serializer_class = UserProtoSerializer\n```\n#### Register handlers[¶](#register-handlers)\n\nOk, let’s wire up the gRPC handlers, edit `quickstart/urls.py`:\n```\nimport account_pb2_grpc from account.services import UserService\n\nurlpatterns = []\n\ndef grpc_handlers(server):\n    account_pb2_grpc.add_UserControllerServicer_to_server(UserService.as_servicer(), server)\n```\nWe’re done, the project layout should look like:\n```\n.\n./quickstart\n./quickstart/asgi.py\n./quickstart/__init__.py\n./quickstart/settings.py\n./quickstart/urls.py\n./quickstart/wsgi.py\n./manage.py\n./account\n./account/migrations\n./account/migrations/__init__.py\n./account/services.py\n./account/models.py\n./account/serializers.py\n./account/__init__.py\n./account/apps.py\n./account/admin.py\n./account/tests.py\n./account.proto\n./account_pb2_grpc.py\n./account_pb2.py\n```\n#### Calling our service[¶](#calling-our-service)\n\nFire up the server with development mode:\n```\npython manage.py grpcrunserver --dev\n```\nWe can now access our service from the gRPC client:\n```\nimport grpc import account_pb2 import account_pb2_grpc\n\nwith grpc.insecure_channel('localhost:50051') as channel:\n    stub = account_pb2_grpc.UserControllerStub(channel)\n    for user in stub.List(account_pb2.UserListRequest()):\n        print(user, end='')\n```\n### Tutorial[¶](#tutorial)\n\nThis part provides a basic introduction to work with Django gRPC framework.\nIn this tutorial, we will create a simple blog rpc server. You can get the source code in [tutorial example](https://github.com/fengsp/django-grpc-framework/tree/master/examples/tutorial).\n\n#### Building Services[¶](#building-services)\n\nThis tutorial will create a simple blog gRPC Service.\n\n##### Environment setup[¶](#environment-setup)\n\nCreate a new virtual environment for our project:\n```\npython3 -m venv env source env/bin/activate\n```\nInstall our packages:\n```\npip install django pip install djangorestframework   # we need the serialization pip install djangogrpcframework pip install grpcio pip install grpcio-tools\n```\n##### Project setup[¶](#project-setup)\n\nLet’s create a new project to work with:\n```\ndjango-admin startproject tutorial cd tutorial\n```\nNow we can create an app that we’ll use to create a simple gRPC Service:\n```\npython manage.py startapp blog\n```\nWe’ll need to add our new `blog` app and the `django_grpc_framework` app to\n`INSTALLED_APPS`. Let’s edit the `tutorial/settings.py` file:\n```\nINSTALLED_APPS = [\n    ...\n    'django_grpc_framework',\n    'blog',\n]\n```\n##### Create a model[¶](#create-a-model)\n\nNow we’re going to create a simple `Post` model that is used to store blog posts. Edit the `blog/models.py` file:\n```\nfrom django.db import models\n\nclass Post(models.Model):\n    title = models.CharField(max_length=100)\n    content = models.TextField()\n    created = models.DateTimeField(auto_now_add=True)\n\n    class Meta:\n        ordering = ['created']\n```\nWe also need to create a migration for our post model, and sync the database:\n```\npython manage.py makemigrations blog python manage.py migrate\n```\n##### Defining a service[¶](#defining-a-service)\n\nOur first step is to define the gRPC service and messages, create a directory\n`tutorial/protos` that sits next to `tutorial/manage.py`, create another directory `protos/blog_proto` and create the `protos/blog_proto/post.proto`\nfile:\n```\nsyntax = \"proto3\";\n\npackage blog_proto;\n\nimport \"google/protobuf/empty.proto\";\n\nservice PostController {\n    rpc List(PostListRequest) returns (stream Post) {}\n    rpc Create(Post) returns (Post) {}\n    rpc Retrieve(PostRetrieveRequest) returns (Post) {}\n    rpc Update(Post) returns (Post) {}\n    rpc Destroy(Post) returns (google.protobuf.Empty) {}\n}\n\nmessage Post {\n    int32 id = 1;\n    string title = 2;\n    string content = 3;\n}\n\nmessage PostListRequest {\n}\n\nmessage PostRetrieveRequest {\n    int32 id = 1;\n}\n```\nFor a model-backed service, you could also just run the model proto generator:\n```\npython manage.py generateproto --model blog.models.Post --fields=id,title,content --file protos/blog_proto/post.proto\n```\nThen edit it as needed, here the package name can’t be automatically inferred by the proto generator, change `package post` to `package blog_proto`.\n\nNext we need to generate gRPC code, from the `tutorial` directory, run:\n```\npython -m grpc_tools.protoc --proto_path=./protos --python_out=./ --grpc_python_out=./ ./protos/blog_proto/post.proto\n```\n##### Create a Serializer class[¶](#create-a-serializer-class)\n\nBefore we implement our gRPC service, we need to provide a way of serializing and deserializing the post instances into protocol buffer messages. We can do this by declaring serializers, create a file in the `blog` directory named `serializers.py` and add the following:\n```\nfrom django_grpc_framework import proto_serializerss from blog.models import Post from blog_proto import post_pb2\n\nclass PostProtoSerializer(proto_serializers.ModelProtoSerializer):\n    class Meta:\n        model = Post\n        proto_class = post_pb2.Post\n        fields = ['id', 'title', 'content']\n```\n##### Write a service[¶](#write-a-service)\n\nWith our serializer class, we’ll write a regular grpc service, create a file in the `blog` directory named `services.py` and add the following:\n```\nimport grpc from google.protobuf import empty_pb2 from django_grpc_framework.services import Service from blog.models import Post from blog.serializers import PostProtoSerializer\n\nclass PostService(Service):\n    def List(self, request, context):\n        posts = Post.objects.all()\n        serializer = PostProtoSerializer(posts, many=True)\n        for msg in serializer.message:\n            yield msg\n\n    def Create(self, request, context):\n        serializer = PostProtoSerializer(message=request)\n        serializer.is_valid(raise_exception=True)\n        serializer.save()\n        return serializer.message\n\n    def get_object(self, pk):\n        try:\n            return Post.objects.get(pk=pk)\n        except Post.DoesNotExist:\n            self.context.abort(grpc.StatusCode.NOT_FOUND, 'Post:%s not found!' % pk)\n\n    def Retrieve(self, request, context):\n        post = self.get_object(request.id)\n        serializer = PostProtoSerializer(post)\n        return serializer.message\n\n    def Update(self, request, context):\n        post = self.get_object(request.id)\n        serializer = PostProtoSerializer(post, message=request)\n        serializer.is_valid(raise_exception=True)\n        serializer.save()\n        return serializer.message\n\n    def Destroy(self, request, context):\n        post = self.get_object(request.id)\n        post.delete()\n        return empty_pb2.Empty()\n```\nFinally we need to wire there services up, create `blog/handlers.py` file:\n```\nfrom blog._services import PostService from blog_proto import post_pb2_grpc\n\ndef grpc_handlers(server):\n    post_pb2_grpc.add_PostControllerServicer_to_server(PostService.as_servicer(), server)\n```\nAlso we need to wire up the root handlers conf, in `tutorial/urls.py`\nfile, include our blog app’s grpc handlers:\n```\nfrom blog.handlers import grpc_handlers as blog_grpc_handlers\n\nurlpatterns = []\n\ndef grpc_handlers(server):\n    blog_grpc_handlers(server)\n```\n##### Calling our service[¶](#calling-our-service)\n\nNow we can start up a gRPC server so that clients can actually use our service:\n```\npython manage.py grpcrunserver --dev\n```\nIn another terminal window, we can test the server:\n```\nimport grpc from blog_proto import post_pb2, post_pb2_grpc\n\nwith grpc.insecure_channel('localhost:50051') as channel:\n    stub = post_pb2_grpc.PostControllerStub(channel)\n    print('--- Create ---')\n    response = stub.Create(post_pb2.Post(title='t1', content='c1'))\n    print(response, end='')\n    print('--- List ---')\n    for post in stub.List(post_pb2.PostListRequest()):\n        print(post, end='')\n    print('--- Retrieve ---')\n    response = stub.Retrieve(post_pb2.PostRetrieveRequest(id=response.id))\n    print(response, end='')\n    print('--- Update ---')\n    response = stub.Update(post_pb2.Post(id=response.id, title='t2', content='c2'))\n    print(response, end='')\n    print('--- Delete ---')\n    stub.Destroy(post_pb2.Post(id=response.id))\n```\n#### Using Generic Services[¶](#using-generic-services)\n\nWe provide a number of pre-built services as a shortcut for common usage patterns. The generic services allow you to quickly build services that map closely to database models.\n\n##### Using mixins[¶](#using-mixins)\n\nThe create/list/retrieve/update/destroy operations that we’ve been using so far are going to be similar for any model-backend services. Those operations are implemented in gRPC framework’s mixin classes.\n\nLet’s take a look at how we can compose the services by using the mixin classes, here is our `blog/services` file again:\n```\nfrom blog.models import Post from blog.serializers import PostProtoSerializer from django_grpc_framework import mixins from django_grpc_framework import generics\n\nclass PostService(mixins.ListModelMixin,\n                  mixins.CreateModelMixin,\n                  mixins.RetrieveModelMixin,\n                  mixins.UpdateModelMixin,\n                  mixins.DestroyModelMixin,\n                  generics.GenericService):\n    queryset = Post.objects.all()\n    serializer_class = PostProtoSerializer\n```\nWe are building our service with `GenericService`, and adding in\n`ListModelMixin`,``CreateModelMixin``, etc. The base class provides the core functionality, and the mixin classes provice the `.List()` and\n`.Create()` handlers.\n\n##### Using model service[¶](#using-model-service)\n\nIf you want all operations of create/list/retrieve/update/destroy, we provide one already mixed-in generic services:\n```\nclass PostService(generics.ModelService):\n    queryset = Post.objects.all()\n    serializer_class = PostProtoSerializer\n```\n#### Writing and running tests[¶](#writing-and-running-tests)\n\nLet’s write some tests for our service and run them.\n\n##### Writing tests[¶](#id1)\n\nLet’s edit the `blog/tests.py` file:\n```\nimport grpc from django_grpc_framework.test import RPCTestCase from blog_proto import post_pb2, post_pb2_grpc from blog.models import Post\n\nclass PostServiceTest(RPCTestCase):\n    def test_create_post(self):\n        stub = post_pb2_grpc.PostControllerStub(self.channel)\n        response = stub.Create(post_pb2.Post(title='title', content='content'))\n        self.assertEqual(response.title, 'title')\n        self.assertEqual(response.content, 'content')\n        self.assertEqual(Post.objects.count(), 1)\n\n    def test_list_posts(self):\n        Post.objects.create(title='title1', content='content1')\n        Post.objects.create(title='title2', content='content2')\n        stub = post_pb2_grpc.PostControllerStub(self.channel)\n        post_list = list(stub.List(post_pb2.PostListRequest()))\n        self.assertEqual(len(post_list), 2)\n```\n##### Running tests[¶](#running-tests)\n\nOnce you’ve written tests, run them:\n```\npython manage.py test\n```\n### Services[¶](#services)\n\nDjango gRPC framework provides an `Service` class, which is pretty much the same as using a regular gRPC generated servicer interface. For example:\n```\nimport grpc from django_grpc_framework.services import Service from blog.models import Post from blog.serializers import PostProtoSerializer\n\nclass PostService(Service):\n    def get_object(self, pk):\n        try:\n            return Post.objects.get(pk=pk)\n        except Post.DoesNotExist:\n            self.context.abort(grpc.StatusCode.NOT_FOUND, 'Post:%s not found!' % pk)\n\n    def Retrieve(self, request, context):\n        post = self.get_object(request.id)\n        serializer = PostProtoSerializer(post)\n        return serializer.message\n```\n#### Service instance attributes[¶](#service-instance-attributes)\n\nThe following attributes are available in a service instance.\n\n* `.request` - the gRPC request object\n* `.context` - the `grpc.ServicerContext` object\n* `.action` - the name of the current service method\n\n#### As servicer method[¶](#as-servicer-method)\n\n*classmethod* `Service.``as_servicer`(***initkwargs*)[¶](#django_grpc_framework.services.Service.as_servicer)\nReturns a gRPC servicer instance:\n```\nservicer = PostService.as_servicer()\nadd_PostControllerServicer_to_server(servicer, server)\n```\n#### Root handlers hook[¶](#root-handlers-hook)\n\nWe need a hanlders hook function to add all servicers to the server, for example:\n```\ndef grpc_handlers(server):\n    demo_pb2_grpc.add_UserControllerServicer_to_server(UserService.as_servicer(), server)\n```\nYou can set the root handlers hook using the `ROOT_HANDLERS_HOOK` setting key, for example set the following in your `settings.py` file:\n```\nGRPC_FRAMEWORK = {\n    ...\n    'ROOT_HANDLERS_HOOK': 'path.to.your.curtom_grpc_handlers',\n}\n```\nThe default setting is `'{settings.ROOT_URLCONF}.grpc_handlers'`.\n\n### Generic services[¶](#generic-services)\n\nThe generic services provided by gRPC framework allow you to quickly build gRPC services that map closely to your database models. If the generic services don’t suit your needs, use the regular `Service` class, or reuse the mixins and base classes used by the generic services to compose your own set of ressable generic services.\n\nFor example:\n```\nfrom blog.models import Post from blog.serializers import PostProtoSerializer from django_grpc_framework import generics\n\nclass PostService(generics.ModelService):\n   queryset = Post.objects.all()\n   serializer_class = PostProtoSerializer\n```\n#### GenericService[¶](#genericservice)\n\nThis class extends `Service` class, adding commonly required behavior for standard list and detail services. All concrete generic services is built by composing `GenericService`, with one or more mixin classes.\n\n##### Attributes[¶](#attributes)\n\n**Basic settings:**\n\nThe following attributes control the basic service behavior:\n\n* `queryset` - The queryset that should be used for returning objects from this service. You must set this or override the `get_queryset` method, you should call `get_queryset` instead of accessing this property directly, as `queryset`\nwill get evaluated once, and those results will be cached for all subsequent requests.\n* `serializer_class` - The serializer class that should be used for validating and deserializing input, and for serializing output. You must either set this attribute, or override the `get_serializer_class()` method.\n* `lookup_field` - The model field that should be used to for performing object lookup of individual model instances. Defaults to primary key field name.\n* `lookup_request_field` - The request field that should be used for object lookup. If unset this defaults to using the same value as `lookup_field`.\n\n##### Methods[¶](#methods)\n\n*class* `django_grpc_framework.generics.``GenericService`(***kwargs*)[¶](#django_grpc_framework.generics.GenericService)\nBase class for all other generic services.\n\n`filter_queryset`(*queryset*)[¶](#django_grpc_framework.generics.GenericService.filter_queryset)\nGiven a queryset, filter it, returning a new queryset.\n\n`get_object`()[¶](#django_grpc_framework.generics.GenericService.get_object)\nReturns an object instance that should be used for detail services.\nDefaults to using the lookup_field parameter to filter the base queryset.\n\n`get_queryset`()[¶](#django_grpc_framework.generics.GenericService.get_queryset)\nGet the list of items for this service.\nThis must be an iterable, and may be a queryset.\nDefaults to using `self.queryset`.\n\nIf you are overriding a handler method, it is important that you call\n`get_queryset()` instead of accessing the `queryset` attribute as\n`queryset` will get evaluated only once.\n\nOverride this to provide dynamic behavior, for example:\n```\ndef get_queryset(self):\n    if self.action == 'ListSpecialUser':\n        return SpecialUser.objects.all()\n    return super().get_queryset()\n```\n`get_serializer`(**args*, ***kwargs*)[¶](#django_grpc_framework.generics.GenericService.get_serializer)\nReturn the serializer instance that should be used for validating and deserializing input, and for serializing output.\n\n`get_serializer_class`()[¶](#django_grpc_framework.generics.GenericService.get_serializer_class)\nReturn the class to use for the serializer. Defaults to using self.serializer_class.\n\n`get_serializer_context`()[¶](#django_grpc_framework.generics.GenericService.get_serializer_context)\nExtra context provided to the serializer class. Defaults to including\n`grpc_request`, `grpc_context`, and `service` keys.\n\n#### Mixins[¶](#mixins)\n\nThe mixin classes provide the actions that are used to privide the basic service behavior. The mixin classes can be imported from\n`django_grpc_framework.mixins`.\n\n*class* `django_grpc_framework.mixins.``ListModelMixin`[¶](#django_grpc_framework.mixins.ListModelMixin)\n\n`List`(*request*, *context*)[¶](#django_grpc_framework.mixins.ListModelMixin.List)\nList a queryset. This sends a sequence of messages of\n`serializer.Meta.proto_class` to the client.\n\nNote\n\nThis is a server streaming RPC.\n\n*class* `django_grpc_framework.mixins.``CreateModelMixin`[¶](#django_grpc_framework.mixins.CreateModelMixin)\n\n`Create`(*request*, *context*)[¶](#django_grpc_framework.mixins.CreateModelMixin.Create)\nCreate a model instance.\n\nThe request shoule be a proto message of `serializer.Meta.proto_class`.\nIf an object is created this returns a proto message of\n`serializer.Meta.proto_class`.\n\n`perform_create`(*serializer*)[¶](#django_grpc_framework.mixins.CreateModelMixin.perform_create)\nSave a new object instance.\n\n*class* `django_grpc_framework.mixins.``RetrieveModelMixin`[¶](#django_grpc_framework.mixins.RetrieveModelMixin)\n\n`Retrieve`(*request*, *context*)[¶](#django_grpc_framework.mixins.RetrieveModelMixin.Retrieve)\nRetrieve a model instance.\n\nThe request have to include a field corresponding to\n`lookup_request_field`. If an object can be retrieved this returns a proto message of `serializer.Meta.proto_class`.\n\n*class* `django_grpc_framework.mixins.``UpdateModelMixin`[¶](#django_grpc_framework.mixins.UpdateModelMixin)\n\n`Update`(*request*, *context*)[¶](#django_grpc_framework.mixins.UpdateModelMixin.Update)\nUpdate a model instance.\n\nThe request shoule be a proto message of `serializer.Meta.proto_class`.\nIf an object is updated this returns a proto message of\n`serializer.Meta.proto_class`.\n\n`perform_update`(*serializer*)[¶](#django_grpc_framework.mixins.UpdateModelMixin.perform_update)\nSave an existing object instance.\n\n*class* `django_grpc_framework.mixins.``DestroyModelMixin`[¶](#django_grpc_framework.mixins.DestroyModelMixin)\n\n`Destroy`(*request*, *context*)[¶](#django_grpc_framework.mixins.DestroyModelMixin.Destroy)\nDestroy a model instance.\n\nThe request have to include a field corresponding to\n`lookup_request_field`. If an object is deleted this returns a proto message of `google.protobuf.empty_pb2.Empty`.\n\n`perform_destroy`(*instance*)[¶](#django_grpc_framework.mixins.DestroyModelMixin.perform_destroy)\nDelete an object instance.\n\n#### Concrete service classes[¶](#concrete-service-classes)\n\nThe following classes are the concrete generic services. They can be imported from `django_grpc_framework.generics`.\n\n*class* `django_grpc_framework.generics.``CreateService`(***kwargs*)[¶](#django_grpc_framework.generics.CreateService)\nConcrete service for creating a model instance that provides a `Create()`\nhandler.\n\n*class* `django_grpc_framework.generics.``ListService`(***kwargs*)[¶](#django_grpc_framework.generics.ListService)\nConcrete service for listing a queryset that provides a `List()` handler.\n\n*class* `django_grpc_framework.generics.``RetrieveService`(***kwargs*)[¶](#django_grpc_framework.generics.RetrieveService)\nConcrete service for retrieving a model instance that provides a\n`Retrieve()` handler.\n\n*class* `django_grpc_framework.generics.``DestroyService`(***kwargs*)[¶](#django_grpc_framework.generics.DestroyService)\nConcrete service for deleting a model instance that provides a `Destroy()`\nhandler.\n\n*class* `django_grpc_framework.generics.``UpdateService`(***kwargs*)[¶](#django_grpc_framework.generics.UpdateService)\nConcrete service for updating a model instance that provides a\n`Update()` handler.\n\n*class* `django_grpc_framework.generics.``ReadOnlyModelService`(***kwargs*)[¶](#django_grpc_framework.generics.ReadOnlyModelService)\nConcrete service that provides default `List()` and `Retrieve()`\nhandlers.\n\n*class* `django_grpc_framework.generics.``ModelService`(***kwargs*)[¶](#django_grpc_framework.generics.ModelService)\nConcrete service that provides default `Create()`, `Retrieve()`,\n`Update()`, `Destroy()` and `List()` handlers.\n\nYou may need to provide custom classes that have certain actions, to create a base class that provides `List()` and `Create()` handlers, inherit from\n`GenericService` and mixin the required handlers:\n```\nfrom django_grpc_framework import mixins from django_grpc_framework import generics\n\nclass ListCreateService(mixins.CreateModelMixin,\n                        mixins.ListModelMixin,\n                        GenericService):\n    \"\"\"\n Concrete service that provides ``Create()`` and ``List()`` handlers.\n \"\"\"\n    pass\n```\n### Proto Serializers[¶](#proto-serializers)\n\nThe serializers work almost exactly the same with REST framework’s `Serializer`\nclass and `ModelSerializer`, but use `message` instead of `data` as input and output.\n\n#### Declaring serializers[¶](#declaring-serializers)\n\nDeclaring a serializer looks very similar to declaring a rest framework serializer:\n```\nfrom rest_framework import serializers from django_grpc_framework import proto_serializers\n\nclass PersonProtoSerializer(proto_serializers.ProtoSerializer):\n    name = serializers.CharField(max_length=100)\n    email = serializers.EmailField(max_length=100)\n\n    class Meta:\n        proto_class = hrm_pb2.Person\n```\n#### Overriding serialization and deserialization behavior[¶](#overriding-serialization-and-deserialization-behavior)\n\nA proto serializer is the same as one rest framework serializer, but we are adding the following logic:\n\n* Protobuf message -> Dict of python primitive datatypes.\n* Protobuf message <- Dict of python primitive datatypes.\n\nIf you need to alter the convert behavior of a serializer class, you can do so by overriding the `.message_to_data()` or `.data_to_message` methods.\n\nHere is the default implementation:\n```\nfrom google.protobuf.json_format import MessageToDict, ParseDict\n\nclass ProtoSerializer(BaseProtoSerializer, Serializer):\n    def message_to_data(self, message):\n        \"\"\"Protobuf message -> Dict of python primitive datatypes.\n \"\"\"\n        return MessageToDict(\n            message, including_default_value_fields=True,\n            preserving_proto_field_name=True\n        )\n\n    def data_to_message(self, data):\n        \"\"\"Protobuf message <- Dict of python primitive datatypes.\"\"\"\n        return ParseDict(\n            data, self.Meta.proto_class(),\n            ignore_unknown_fields=True\n        )\n```\nThe default behavior requires you to provide `ProtoSerializer.Meta.proto_class`,\nit is the protobuf class that should be used for create output proto message object. You must either set this attribute, or override the\n`data_to_message()` method.\n\n#### Serializing objects[¶](#serializing-objects)\n\nWe can now use `PersonProtoSerializer` to serialize a person object:\n```\n>>> serializer = PersonProtoSerializer(person)\n>>> serializer.message name: \"amy\"\nemail: \"\"\n>>> type(serializer.message)\n\n```\n#### Deserializing objects[¶](#deserializing-objects)\n\nDeserialization is similar:\n```\n>>> serializer = PersonProtoSerializer(message=message)\n>>> serializer.is_valid()\nTrue\n>>> serializer.validated_data OrderedDict([('name', 'amy'), ('email', '')])\n```\n#### ModelProtoSerializer[¶](#modelprotoserializer)\n\nThis is the same as a rest framework `ModelSerializer`:\n```\nfrom django_grpc_framework import proto_serializers from hrm.models import Person import hrm_pb2\n\nclass PersonProtoSerializer(proto_serializers.ModelProtoSerializer):\n    class Meta:\n        model = Person\n        proto_class = hrm_pb2.Person\n        fields = '__all__'\n```\n### Proto[¶](#proto)\n\nDjango gRPC framework provides support for automatic generation of [proto](https://developers.google.com/protocol-buffers/docs/proto3).\n\n#### Generate proto for model[¶](#generate-proto-for-model)\n\nIf you want to automatically generate proto definition based on a model,\nyou can use the `generateproto` management command:\n```\npython manage.py generateproto --model django.contrib.auth.models.User\n```\nTo specify fields and save it to a file, use:\n```\npython manage.py generateproto --model django.contrib.auth.models.User --fields id,username,email --file demo.proto\n```\nOnce you’ve generated a proto file in this way, you can edit it as you wish.\n\n### Server[¶](#server)\n\n#### grpcrunserver[¶](#grpcrunserver)\n\nRun a grpc server:\n```\n$ python manage.py grpcrunserver\n```\nRun a grpc development server, this tells Django to use the auto-reloader and run checks:\n```\n$ python manage.py grpcrunserver --dev\n```\nRun the server with a certain address:\n```\n$ python manage.py grpcrunserver 127.0.0.1:8000 --max-workers 5\n```\n#### Configuration[¶](#configuration)\n\n##### Setting the server interceptors[¶](#setting-the-server-interceptors)\n\nIf you need to add server interceptors, you can do so by setting the\n\n`SERVER_INTERCEPTORS` setting. For example, have something like this in your `settings.py` file:\n```\nGRPC_FRAMEWORK = {\n    ...\n    'SERVER_INTERCEPTORS': [\n        'path.to.DoSomethingInterceptor',\n        'path.to.DoAnotherThingInterceptor',\n    ]\n}\n```\n### Testing[¶](#testing)\n\nDjango gRPC framework includes a few helper classes that come in handy when writing tests for services.\n\n#### The test channel[¶](#the-test-channel)\n\nThe test channel is a Python class that acts as a dummy gRPC channel,\nallowing you to test you services. You can simulate gRPC requests on a service method and get the response. Here is a quick example, let’s open Django shell `python manage.py shell`:\n```\n>>> from django_grpc_framework.test import Channel\n>>> channel = Channel()\n>>> stub = post_pb2_grpc.PostControllerStub(channel)\n>>> response = stub.Retrieve(post_pb2.PostRetrieveRequest(id=post_id))\n>>> response.title\n'This is a title'\n```\n#### RPC test cases[¶](#rpc-test-cases)\n\nDjango gRPC framework includes the following test case classes, that mirror the existing Django test case classes, but provide a test `Channel`\ninstead of `Client`.\n\n* `RPCSimpleTestCase`\n* `RPCTransactionTestCase`\n* `RPCTestCase`\n\nYou can use these test case classes as you would for the regular Django test case classes, the `self.channel` attribute will be an `Channel` instance:\n```\nfrom django_grpc_framework.test import RPCTestCase from django.contrib.auth.models import User import account_pb2 import account_pb2_grpc\n\nclass UserServiceTest(RPCTestCase):\n    def test_create_user(self):\n        stub = account_pb2_grpc.UserControllerStub(self.channel)\n        response = stub.Create(account_pb2.User(username='tom', email=''))\n        self.assertEqual(response.username, 'tom')\n        self.assertEqual(response.email, '')\n        self.assertEqual(User.objects.count(), 1)\n```\n### Settings[¶](#settings)\n\nConfiguration for gRPC framework is all namespaced inside a single Django setting, named `GRPC_FRAMEWORK`, for example your project’s `settings.py`\nfile might look like this:\n```\nGRPC_FRAMEWORK = {\n    'ROOT_HANDLERS_HOOK': 'project.urls.grpc_handlers',\n}\n```\n#### Accessing settings[¶](#accessing-settings)\n\nIf you need to access the values of gRPC framework’s settings in your project,\nyou should use the `grpc_settings` object. For example:\n```\nfrom django_grpc_framework.settings import grpc_settings print(grpc_settings.ROOT_HANDLERS_HOOK)\n```\nThe `grpc_settings` object will check for any user-defined settings, and otherwise fall back to the default values. Any setting that uses string import paths to refer to a class will automatically import and return the referenced class, instead of the string literal.\n\n#### Configuration values[¶](#configuration-values)\n\n`ROOT_HANDLERS_HOOK`[¶](#ROOT_HANDLERS_HOOK)\nA hook function that takes gRPC server object as a single parameter and add all servicers to the server.\n\nDefault: `'{settings.ROOT_URLCONF}.grpc_handlers'`\n\nOne example for the hook function:\n```\ndef grpc_handlers(server):\n    demo_pb2_grpc.add_UserControllerServicer_to_server(UserService.as_servicer(), server)\n```\n`SERVER_INTERCEPTORS`[¶](#SERVER_INTERCEPTORS)\nAn optional list of ServerInterceptor objects that observe and optionally manipulate the incoming RPCs before handing them over to handlers.\n\nDefault: `None`\n\n### Patterns for gRPC[¶](#patterns-for-grpc)\n\nThis part contains some snippets and patterns for Django gRPC framework.\n\n#### Handling Partial Update[¶](#handling-partial-update)\n\nIn proto3:\n\n1. All fields are optional 2. Singular primitive fields, repeated fields, and map fields are initialized with default values (0, empty list, etc). There’s no way of telling whether a field was explicitly set to the default value (for example whether a boolean was set to false) or just not set at all.\n\nIf we want to do a partial update on resources, we need to know whether a field was set or not set at all. There are different strategies that can be used to represent `unset`, we’ll use a pattern called `\"Has Pattern\"` here.\n\n##### Singular field absence[¶](#singular-field-absence)\n\nIn proto3, for singular field types, you can use the parent message’s\n`HasField()` method to check if a message type field value has been set,\nbut you can’t do it with non-message singular types.\n\nFor primitive types if you need `HasField` to you could use\n`\"google/protobuf/wrappers.proto\"`. Wrappers are useful for places where you need to distinguish between the absence of a primitive typed field and its default value:\n```\nimport \"google/protobuf/wrappers.proto\";\n\nservice PersonController {\n    rpc PartialUpdate(PersonPartialUpdateRequest) returns (Person) {}\n}\n\nmessage Person {\n    int32 id = 1;\n    string name = 2;\n    string email = 3;\n}\n\nmessage PersonPartialUpdateRequest {\n    int32 id = 1;\n    google.protobuf.StringValue name = 2;\n    google.protobuf.StringValue email = 3;\n}\n```\nHere is the client usage:\n```\nfrom google.protobuf.wrappers_pb2 import StringValue\n\nwith grpc.insecure_channel('localhost:50051') as channel:\n    stub = hrm_pb2_grpc.PersonControllerStub(channel)\n    request = hrm_pb2.PersonPartialUpdateRequest(id=1, name=StringValue(value=\"amy\"))\n    response = stub.PartialUpdate(request)\n    print(response, end='')\n```\nThe service implementation:\n```\nclass PersonService(generics.GenericService):\n    queryset = Person.objects.all()\n    serializer_class = PersonProtoSerializer\n\n    def PartialUpdate(self, request, context):\n        instance = self.get_object()\n        serializer = self.get_serializer(instance, message=request, partial=True)\n        serializer.is_valid(raise_exception=True)\n        serializer.save()\n        return serializer.message\n```\nOr you can just use `PartialUpdateModelMixin` to get the same behavior:\n```\nclass PersonService(mixins.PartialUpdateModelMixin,\n                    generics.GenericService):\n    queryset = Person.objects.all()\n    serializer_class = PersonProtoSerializer\n```\n##### Repeated and map field absence[¶](#repeated-and-map-field-absence)\n\nIf you need to check whether repeated fields and map fields are set or not,\nyou need to do it manually:\n```\nmessage PersonPartialUpdateRequest {\n    int32 id = 1;\n    google.protobuf.StringValue name = 2;\n    google.protobuf.StringValue email = 3;\n    repeated int32 groups = 4;\n    bool is_groups_set = 5;\n}\n```\n#### Null Support[¶](#null-support)\n\nIn proto3, all fields are never null. However, we can use `Oneof` to define a nullable type, for example:\n```\nsyntax = \"proto3\";\n\npackage snippets;\n\nimport \"google/protobuf/struct.proto\";\n\nservice SnippetController {\n    rpc Update(Snippet) returns (Snippet) {}\n}\n\nmessage NullableString {\n    oneof kind {\n        string value = 1;\n        google.protobuf.NullValue null = 2;\n    }\n}\n\nmessage Snippet {\n    int32 id = 1;\n    string title = 2;\n    NullableString language = 3;\n}\n```\nThe client example:\n```\nimport grpc import snippets_pb2 import snippets_pb2_grpc from google.protobuf.struct_pb2 import NullValue\n\nwith grpc.insecure_channel('localhost:50051') as channel:\n    stub = snippets_pb2_grpc.SnippetControllerStub(channel)\n    request = snippets_pb2.Snippet(id=1, title='snippet title')\n    # send non-null value\n    # request.language.value = \"python\"\n    # send null value\n    request.language.null = NullValue.NULL_VALUE\n    response = stub.Update(request)\n    print(response, end='')\n```\nThe service implementation:\n```\nfrom django_grpc_framework import generics, mixins from django_grpc_framework import proto_serializers from snippets.models import Snippet import snippets_pb2 from google.protobuf.struct_pb2 import NullValue\n\nclass SnippetProtoSerializer(proto_serializers.ModelProtoSerializer):\n    class Meta:\n        model = Snippet\n        fields = '__all__'\n\n    def message_to_data(self, message):\n        data = {\n            'title': message.title,\n        }\n        if message.language.HasField('value'):\n            data['language'] = message.language.value\n        elif message.language.HasField('null'):\n            data['language'] = None\n        return data\n\n    def data_to_message(self, data):\n        message = snippets_pb2.Snippet(\n            id=data['id'],\n            title=data['title'],\n        )\n        if data['language'] is None:\n            message.language.null = NullValue.NULL_VALUE\n        else:\n            message.language.value = data['language']\n        return message\n\nclass SnippetService(mixins.UpdateModelMixin,\n                     generics.GenericService):\n    queryset = Snippet.objects.all()\n    serializer_class = SnippetProtoSerializer\n```\nAdditional Stuff[¶](#additional-stuff)\n---\n\nChangelog and license here if you are interested.\n\n### Changelog[¶](#changelog)\n\n#### Version 0.2[¶](#version-0-2)\n\n* Added test module\n* Added proto serializers\n* Added proto generators\n\n#### Version 0.1[¶](#version-0-1)\n\nFirst public release.\n\n### License[¶](#license)\n\nThis library is licensed under Apache License.\n\n> > > > > > > > > > > > > Apache License\n> > > > > > > Version 2.0, January 2004\n> > > > > > > > > > \n> > > > TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n> 1. Definitions.\n> “License” shall mean the terms and conditions for use, reproduction,\n> and distribution as defined by Sections 1 through 9 of this document.\n> “Licensor” shall mean the copyright owner or entity authorized by\n> the copyright owner that is granting the License.\n> “Legal Entity” shall mean the union of the acting entity and all\n> other entities that control, are controlled by, or are under common\n> control with that entity. For the purposes of this definition,\n> “control” means (i) the power, direct or indirect, to cause the\n> direction or management of such entity, whether by contract or\n> otherwise, or (ii) ownership of fifty percent (50%) or more of the\n> outstanding shares, or (iii) beneficial ownership of such entity.\n> “You” (or “Your”) shall mean an individual or Legal Entity\n> exercising permissions granted by this License.\n> “Source” form shall mean the preferred form for making modifications,\n> including but not limited to software source code, documentation\n> source, and configuration files.\n> “Object” form shall mean any form resulting from mechanical\n> transformation or translation of a Source form, including but\n> not limited to compiled object code, generated documentation,\n> and conversions to other media types.\n> “Work” shall mean the work of authorship, whether in Source or\n> Object form, made available under the License, as indicated by a\n> copyright notice that is included in or attached to the work\n> (an example is provided in the Appendix below).\n> “Derivative Works” shall mean any work, whether in Source or Object\n> form, that is based on (or derived from) the Work and for which the\n> editorial revisions, annotations, elaborations, or other modifications\n> represent, as a whole, an original work of authorship. For the purposes\n> of this License, Derivative Works shall not include works that remain\n> separable from, or merely link (or bind by name) to the interfaces of,\n> the Work and Derivative Works thereof.\n> “Contribution” shall mean any work of authorship, including\n> the original version of the Work and any modifications or additions\n> to that Work or Derivative Works thereof, that is intentionally\n> submitted to Licensor for inclusion in the Work by the copyright owner\n> or by an individual or Legal Entity authorized to submit on behalf of\n> the copyright owner. For the purposes of this definition, “submitted”\n> means any form of electronic, verbal, or written communication sent\n> to the Licensor or its representatives, including but not limited to\n> communication on electronic mailing lists, source code control systems,\n> and issue tracking systems that are managed by, or on behalf of, the\n> Licensor for the purpose of discussing and improving the Work, but\n> excluding communication that is conspicuously marked or otherwise\n> designated in writing by the copyright owner as “Not a Contribution.”\n> “Contributor” shall mean Licensor and any individual or Legal Entity\n> on behalf of whom a Contribution has been received by Licensor and\n> subsequently incorporated within the Work.\n> 2. Grant of Copyright License. Subject to the terms and conditions of\n> this License, each Contributor hereby grants to You a perpetual,\n> worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n> copyright license to reproduce, prepare Derivative Works of,\n> publicly display, publicly perform, sublicense, and distribute the\n> Work and such Derivative Works in Source or Object form.\n> 3. Grant of Patent License. Subject to the terms and conditions of\n> this License, each Contributor hereby grants to You a perpetual,\n> worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n> (except as stated in this section) patent license to make, have made,\n> use, offer to sell, sell, import, and otherwise transfer the Work,\n> where such license applies only to those patent claims licensable\n> by such Contributor that are necessarily infringed by their\n> Contribution(s) alone or by combination of their Contribution(s)\n> with the Work to which such Contribution(s) was submitted. If You\n> institute patent litigation against any entity (including a\n> cross-claim or counterclaim in a lawsuit) alleging that the Work\n> or a Contribution incorporated within the Work constitutes direct\n> or contributory patent infringement, then any patent licenses\n> granted to You under this License for that Work shall terminate\n> as of the date such litigation is filed.\n> 4. Redistribution. You may reproduce and distribute copies of the\n> Work or Derivative Works thereof in any medium, with or without\n> modifications, and in Source or Object form, provided that You\n> meet the following conditions:\n> \t1. You must give any other recipients of the Work or\n> \tDerivative Works a copy of this License; and\n> \t2. You must cause any modified files to carry prominent notices\n> \tstating that You changed the files; and\n> \t3. You must retain, in the Source form of any Derivative Works\n> \tthat You distribute, all copyright, patent, trademark, and\n> \tattribution notices from the Source form of the Work,\n> \texcluding those notices that do not pertain to any part of\n> \tthe Derivative Works; and\n> \t4. If the Work includes a “NOTICE” text file as part of its\n> \tdistribution, then any Derivative Works that You distribute must\n> \tinclude a readable copy of the attribution notices contained\n> \twithin such NOTICE file, excluding those notices that do not\n> \tpertain to any part of the Derivative Works, in at least one\n> \tof the following places: within a NOTICE text file distributed\n> \tas part of the Derivative Works; within the Source form or\n> \tdocumentation, if provided along with the Derivative Works; or,\n> \twithin a display generated by the Derivative Works, if and\n> \twherever such third-party notices normally appear. The contents\n> \tof the NOTICE file are for informational purposes only and\n> \tdo not modify the License. You may add Your own attribution\n> \tnotices within Derivative Works that You distribute, alongside\n> \tor as an addendum to the NOTICE text from the Work, provided\n> \tthat such additional attribution notices cannot be construed\n> \tas modifying the License.You may add Your own copyright statement to Your modifications and\n> may provide additional or different license terms and conditions\n> for use, reproduction, or distribution of Your modifications, or\n> for any such Derivative Works as a whole, provided Your use,\n> reproduction, and distribution of the Work otherwise complies with\n> the conditions stated in this License.\n> 5. Submission of Contributions. Unless You explicitly state otherwise,\n> any Contribution intentionally submitted for inclusion in the Work\n> by You to the Licensor shall be under the terms and conditions of\n> this License, without any additional terms or conditions.\n> Notwithstanding the above, nothing herein shall supersede or modify\n> the terms of any separate license agreement you may have executed\n> with Licensor regarding such Contributions.\n> 6. Trademarks. This License does not grant permission to use the trade\n> names, trademarks, service marks, or product names of the Licensor,\n> except as required for reasonable and customary use in describing the\n> origin of the Work and reproducing the content of the NOTICE file.\n> 7. Disclaimer of Warranty. Unless required by applicable law or\n> agreed to in writing, Licensor provides the Work (and each\n> Contributor provides its Contributions) on an “AS IS” BASIS,\n> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n> implied, including, without limitation, any warranties or conditions\n> of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n> PARTICULAR PURPOSE. You are solely responsible for determining the\n> appropriateness of using or redistributing the Work and assume any\n> risks associated with Your exercise of permissions under this License.\n> 8. Limitation of Liability. In no event and under no legal theory,\n> whether in tort (including negligence), contract, or otherwise,\n> unless required by applicable law (such as deliberate and grossly\n> negligent acts) or agreed to in writing, shall any Contributor be\n> liable to You for damages, including any direct, indirect, special,\n> incidental, or consequential damages of any character arising as a\n> result of this License or out of the use or inability to use the\n> Work (including but not limited to damages for loss of goodwill,\n> work stoppage, computer failure or malfunction, or any and all\n> other commercial damages or losses), even if such Contributor\n> has been advised of the possibility of such damages.\n> 9. Accepting Warranty or Additional Liability. While redistributing\n> the Work or Derivative Works thereof, You may choose to offer,\n> and charge a fee for, acceptance of support, warranty, indemnity,\n> or other liability obligations and/or rights consistent with this\n> License. However, in accepting such obligations, You may act only\n> on Your own behalf and on Your sole responsibility, not on behalf\n> of any other Contributor, and only if You agree to indemnify,\n> defend, and hold each Contributor harmless for any liability\n> incurred by, or claims asserted against, such Contributor by reason\n> of your accepting any such warranty or additional liability.\n> END OF TERMS AND CONDITIONS\n> APPENDIX: How to apply the Apache License to your work.\n> > > To apply the Apache License to your work, attach the following\n> > boilerplate notice, with the fields enclosed by brackets “[]”\n> > replaced with your own identifying information. (Don’t include\n> > the brackets!) The text should be enclosed in the appropriate\n> > comment syntax for the file format. We also recommend that a\n> > file or class name and description of purpose be included on the\n> > same “printed page” as the copyright notice for easier\n> > identification within third-party archives.\n> Copyright [yyyy] [name of copyright owner]\n> Licensed under the Apache License, Version 2.0 (the “License”);\n> you may not use this file except in compliance with the License.\n> You may obtain a copy of the License at\n> > > \n> Unless required by applicable law or agreed to in writing, software\n> distributed under the License is distributed on an “AS IS” BASIS,\n> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n> See the License for the specific language governing permissions and\n> limitations under the License.\n[django-grpc-framework](index.html#document-index)\n===\n\n### Navigation\n\n* [Installation](index.html#document-installation)\n* [Quickstart](index.html#document-quickstart)\n* [Tutorial](index.html#document-tutorial/index)\n* [Services](index.html#document-services)\n* [Generic services](index.html#document-generics)\n* [Proto Serializers](index.html#document-proto_serializers)\n* [Proto](index.html#document-protos)\n* [Server](index.html#document-server)\n* [Testing](index.html#document-testing)\n* [Settings](index.html#document-settings)\n* [Patterns for gRPC](index.html#document-patterns/index)\n\n* [Changelog](index.html#document-changelog)\n* [License](index.html#document-license)\n\n### Related Topics\n\n* [Documentation overview](index.html#document-index)\n\n### Quick search"}}},{"rowIdx":449,"cells":{"project":{"kind":"string","value":"github.com/go-mangos/mangos"},"source":{"kind":"string","value":"go"},"language":{"kind":"string","value":"Go"},"content":{"kind":"string","value":"README\n [¶](#section-readme)\n---\n\n### mangos\n\n[![Linux Status](https://img.shields.io/travis/go-mangos/mangos.svg?label=linux)](https://travis-ci.org/go-mangos/mangos)\n[![Windows Status](https://img.shields.io/appveyor/ci/gdamore/mangos.svg?label=windows)](https://ci.appveyor.com/project/gdamore/mangos)\n[![Apache License](https://img.shields.io/badge/license-APACHE2-blue.svg)](https://github.com/nanomsg/mangos/raw/master/LICENSE)\n[![Gitter](https://img.shields.io/badge/gitter-join-brightgreen.svg)](https://gitter.im/go-mangos/mangos)\n[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/nanomsg.org/go-mangos)\n[![Go Report Card](https://goreportcard.com/badge/nanomsg.org/go-mangos)](https://goreportcard.com/report/nanomsg.org/go-mangos)\n\nPackage mangos is an implementation in pure Go of the SP\n(\"Scalability Protocols\")\nmessaging system.\nThis makes heavy use of go channels, internally, but it can operate on systems that lack support for cgo.\n\nNOTE: The repository has moved from github.com/go-mangos/mangos.\nPlease import using nanomsg.org/go-mangos. Also, be advised that the master branch of this repository may contain breaking changes.\nTherefore, consider using a tag, such as v1, to ensure that you have the latest stable version.\n\nThe reference implementation of the SP protocols is available as\n[nanomsg™](http://www.nanomsg.org); there is also an effort to implement an improved and more capable version of nanomsg called\n[NNG™](https://github.com/nanomsg/nng).\n\nThe design is intended to make it easy to add new transports with almost trivial effort, as well as new topologies (\"protocols\" in SP terminology.)\n\nAt present, all of the Req/Rep, Pub/Sub, Pair, Bus, Push/Pull, and Surveyor/Respondent patterns are supported.\n\nAdditionally, there is an experimental new pattern called STAR available. This pattern is like Bus, except that the messages are delivered not just to immediate peers, but to all members of the topology. Developers must be careful not to create cycles in their network when using this pattern, otherwise infinite loops can occur.\n\nSupported transports include TCP, inproc, IPC, Websocket, Websocket/TLS and TLS.\nUse addresses of the form \"tls+tcp://:\" to access TLS.\nNote that ipc:// is not supported on Windows (by either this or the reference implementation.) Forcing the local TCP port in Dial is not supported yet (this is rarely useful).\n\nBasic interoperability with nanomsg and NNG has been verified (you can do so yourself with nanocat and macat) for all protocols and transports that NNG and nanomsg support.\nAdditionally there are a number of projects that use the two products together.\n\nThere is a third party experimental QUIC transport available at\n[quic-mangos](https://github.com/lthibault/quic-mangos). (An RFE to make this transport official exists.)\n\nIf you find this useful, I would appreciate knowing about it. I can be reached via my email address, garrett -at- damore -dot- org\n\n### Installing\n\n#### Using *go get*\n```\n$ go get -u github.com/nanomsg/go-mangos\n```\nAfter this command *mangos* is ready to use. Its source will be in:\n```\n$GOPATH/src/pkg/github.com/nanomsg.org/go-mangos\n```\nYou can use `go get -u -a` to update all installed packages.\n\n### Documentation\n\nFor docs, see  or run:\n```\n$ godoc nanomsg.org/go-mangos\n```\n### Testing\n\nThis package supports internal self tests, which can be run in the idiomatic Go way. (Note that most of the tests are in a test subdirectory.)\n```\n$ go test nanomsg.org/go-mangos/...\n```\nThere are also internal benchmarks available:\n```\n$ go test -bench=. nanomsg.org/go-mangos/test\n```\n### Commercial Support\n\n[Staysail Systems, Inc.](mailto:) offers\n[commercial support](http://staysail.tech/support/mangos) for mangos.\n\n### Examples\n\nSome examples are posted in the directories under examples/\nin this project.\n\nThese examples are rewrites (in Go) of 's\n[Getting Started with Nanomsg](http://nanomsg.org/gettingstarted/index.html).\n\ngodoc in the example directories will yield information about how to run each example program.\n\nEnjoy!\n\nCopyright 2018 The Mangos Authors\n\nmangos™, Nanomsg™ and NNG™ are [trademarks](http://nanomsg.org/trademarks.html) of .\n\nDocumentation\n [¶](#section-documentation)\n---\n\n[Rendered for](https://go.dev/about#build-context)\n\nlinux/amd64 windows/amd64 darwin/amd64 js/wasm\n\n \n### Overview [¶](#pkg-overview)\n\nPackage mangos provides a pure Go implementation of the Scalability Protocols. These are more familiarily known as \"nanomsg\" which is the C-based software package that is also their reference implementation.\n\nThese protocols facilitate the rapid creation of applications which rely on multiple participants in sometimes complex communications topologies, including Request/Reply, Publish/Subscribe, Push/Pull,\nSurveyor/Respondant, etc.\n\nFor more information, see www.nanomsg.org.\n\n### Index [¶](#pkg-index)\n\n* [Constants](#pkg-constants)\n* [Variables](#pkg-variables)\n* [func Device(s1 Socket, s2 Socket) error](#Device)\n* [func DrainChannel(ch chan<- *Message, expire time.Time) bool](#DrainChannel)\n* [func NullRecv(ep Endpoint)](#NullRecv)\n* [func ProtocolName(number uint16) string](#ProtocolName)\n* [func ResolveTCPAddr(addr string) (*net.TCPAddr, error)](#ResolveTCPAddr)\n* [func StripScheme(t Transport, addr string) (string, error)](#StripScheme)\n* [func ValidPeers(p1, p2 Protocol) bool](#ValidPeers)\n* [type CondTimed](#CondTimed)\n* + [func (cv *CondTimed) WaitAbsTimeout(when time.Time) bool](#CondTimed.WaitAbsTimeout)\n\t+ [func (cv *CondTimed) WaitRelTimeout(when time.Duration) bool](#CondTimed.WaitRelTimeout)\n* [type Dialer](#Dialer)\n* [type Endpoint](#Endpoint)\n* [type Listener](#Listener)\n* [type Message](#Message)\n* + [func NewMessage(sz int) *Message](#NewMessage)\n* + [func (m *Message) Dup() *Message](#Message.Dup)\n\t+ [func (m *Message) Expired() bool](#Message.Expired)\n\t+ [func (m *Message) Free()](#Message.Free)\n* [type Pipe](#Pipe)\n* + [func NewConnPipe(c net.Conn, sock Socket, props ...interface{}) (Pipe, error)](#NewConnPipe)\n\t+ [func NewConnPipeIPC(c net.Conn, sock Socket, props ...interface{}) (Pipe, error)](#NewConnPipeIPC)\n* [type PipeDialer](#PipeDialer)\n* [type PipeListener](#PipeListener)\n* [type Port](#Port)\n* [type PortAction](#PortAction)\n* [type PortHook](#PortHook)\n* [type Protocol](#Protocol)\n* [type ProtocolRecvHook](#ProtocolRecvHook)\n* [type ProtocolSendHook](#ProtocolSendHook)\n* [type ProtocolSocket](#ProtocolSocket)\n* [type Socket](#Socket)\n* + [func MakeSocket(proto Protocol) Socket](#MakeSocket)\n* [type Transport](#Transport)\n* [type Waiter](#Waiter)\n* + [func (w *Waiter) Add()](#Waiter.Add)\n\t+ [func (w *Waiter) Done()](#Waiter.Done)\n\t+ [func (w *Waiter) Init()](#Waiter.Init)\n\t+ [func (w *Waiter) Wait()](#Waiter.Wait)\n\t+ [func (w *Waiter) WaitAbsTimeout(t time.Time) bool](#Waiter.WaitAbsTimeout)\n\t+ [func (w *Waiter) WaitRelTimeout(d time.Duration) bool](#Waiter.WaitRelTimeout)\n\n### Constants [¶](#pkg-constants)\n\n```\nconst (\n // OptionRaw is used to enable RAW mode processing. The details of\n\t// how this varies from normal mode vary from protocol to protocol.\n\t// RAW mode corresponds to AF_SP_RAW in the C variant, and must be\n\t// used with Devices. In particular, RAW mode sockets are completely\n\t// stateless -- any state between recv/send messages is included in\n\t// the message headers. Protocol names starting with \"X\" default\n\t// to the RAW mode of the same protocol without the leading \"X\".\n\t// The value passed is a bool.\n\tOptionRaw = \"RAW\"\n\n // OptionRecvDeadline is the time until the next Recv times out. The\n\t// value is a time.Duration. Zero value may be passed to indicate that\n\t// no timeout should be applied. A negative value indicates a\n\t// non-blocking operation. By default there is no timeout.\n\tOptionRecvDeadline = \"RECV-DEADLINE\"\n\n // OptionSendDeadline is the time until the next Send times out. The\n\t// value is a time.Duration. Zero value may be passed to indicate that\n\t// no timeout should be applied. A negative value indicates a\n\t// non-blocking operation. By default there is no timeout.\n\tOptionSendDeadline = \"SEND-DEADLINE\"\n\n // OptionRetryTime is used by REQ. The argument is a time.Duration.\n\t// When a request has not been replied to within the given duration,\n\t// the request will automatically be resent to an available peer.\n\t// This value should be longer than the maximum possible processing\n\t// and transport time. The value zero indicates that no automatic\n\t// retries should be sent. The default value is one minute.\n\t//\n\t// Note that changing this option is only guaranteed to affect requests\n\t// sent after the option is set. Changing the value while a request\n\t// is outstanding may not have the desired effect.\n\tOptionRetryTime = \"RETRY-TIME\"\n\n // OptionSubscribe is used by SUB/XSUB. The argument is a []byte.\n\t// The application will receive messages that start with this prefix.\n\t// Multiple subscriptions may be in effect on a given socket. The\n\t// application will not receive messages that do not match any current\n\t// subscriptions. (If there are no subscriptions for a SUB/XSUB\n\t// socket, then the application will not receive any messages. An\n\t// empty prefix can be used to subscribe to all messages.)\n\tOptionSubscribe = \"SUBSCRIBE\"\n\n // OptionUnsubscribe is used by SUB/XSUB. The argument is a []byte,\n\t// representing a previously established subscription, which will be\n\t// removed from the socket.\n\tOptionUnsubscribe = \"UNSUBSCRIBE\"\n\n // OptionSurveyTime is used to indicate the deadline for survey\n\t// responses, when used with a SURVEYOR socket. Messages arriving\n\t// after this will be discarded. Additionally, this will set the\n\t// OptionRecvDeadline when starting the survey, so that attempts to\n\t// receive messages fail with ErrRecvTimeout when the survey is\n\t// concluded. The value is a time.Duration. Zero can be passed to\n\t// indicate an infinite time. Default is 1 second.\n\tOptionSurveyTime = \"SURVEY-TIME\"\n\n // OptionTLSConfig is used to supply TLS configuration details. It\n\t// can be set using the ListenOptions or DialOptions.\n\t// The parameter is a tls.Config pointer.\n\tOptionTLSConfig = \"TLS-CONFIG\"\n\n // OptionWriteQLen is used to set the size, in messages, of the write\n\t// queue channel. By default, it's 128. This option cannot be set if\n\t// Dial or Listen has been called on the socket.\n\tOptionWriteQLen = \"WRITEQ-LEN\"\n\n // OptionReadQLen is used to set the size, in messages, of the read\n\t// queue channel. By default, it's 128. This option cannot be set if\n\t// Dial or Listen has been called on the socket.\n\tOptionReadQLen = \"READQ-LEN\"\n\n // OptionKeepAlive is used to set TCP KeepAlive. Value is a boolean.\n\t// Default is true.\n\tOptionKeepAlive = \"KEEPALIVE\"\n\n // OptionNoDelay is used to configure Nagle -- when true messages are\n\t// sent as soon as possible, otherwise some buffering may occur.\n\t// Value is a boolean. Default is true.\n\tOptionNoDelay = \"NO-DELAY\"\n\n // OptionLinger is used to set the linger property. This is the amount\n\t// of time to wait for send queues to drain when Close() is called.\n\t// Close() may block for up to this long if there is unsent data, but\n\t// will return as soon as all data is delivered to the transport.\n\t// Value is a time.Duration. Default is one second.\n\tOptionLinger = \"LINGER\"\n\n // OptionTTL is used to set the maximum time-to-live for messages.\n\t// Note that not all protocols can honor this at this time, but for\n\t// those that do, if a message traverses more than this many devices,\n\t// it will be dropped. This is used to provide protection against\n\t// loops in the topology. The default is protocol specific.\n\tOptionTTL = \"TTL\"\n\n // OptionMaxRecvSize supplies the maximum receive size for inbound\n\t// messages. This option exists because the wire protocol allows\n\t// the sender to specify the size of the incoming message, and\n\t// if the size were overly large, a bad remote actor could perform a\n\t// remote Denial-Of-Service by requesting ridiculously large message\n\t// sizes and then stalling on send. The default value is 1MB.\n\t//\n\t// A value of 0 removes the limit, but should not be used unless\n\t// absolutely sure that the peer is trustworthy.\n\t//\n\t// Not all transports honor this lmit. For example, this limit\n\t// makes no sense when used with inproc.\n\t//\n\t// Note that the size includes any Protocol specific header. It is\n\t// better to pick a value that is a little too big, than too small.\n\t//\n\t// This option is only intended to prevent gross abuse of the system,\n\t// and not a substitute for proper application message verification.\n\tOptionMaxRecvSize = \"MAX-RCV-SIZE\"\n\n // OptionReconnectTime is the initial interval used for connection\n\t// attempts. If a connection attempt does not succeed, then ths socket\n\t// will wait this long before trying again. An optional exponential\n\t// backoff may cause this value to grow. See OptionMaxReconnectTime\n\t// for more details. This is a time.Duration whose default value is\n\t// 100msec. This option must be set before starting any dialers.\n\tOptionReconnectTime = \"RECONNECT-TIME\"\n\n // OptionMaxReconnectTime is the maximum value of the time between\n\t// connection attempts, when an exponential backoff is used. If this\n\t// value is zero, then exponential backoff is disabled, otherwise\n\t// the value to wait between attempts is doubled until it hits this\n\t// limit. This value is a time.Duration, with initial value 0.\n\t// This option must be set before starting any dialers.\n\tOptionMaxReconnectTime = \"MAX-RECONNECT-TIME\"\n\n // OptionBestEffort enables non-blocking send operations on the\n\t// socket. Normally (for some socket types), a socket will block if\n\t// there are no receivers, or the receivers are unable to keep up\n\t// with the sender. (Multicast sockets types like Bus or Star do not\n\t// behave this way.) If this option is set, instead of blocking, the\n\t// message will be silently discarded. The value is a boolean, and\n\t// defaults to False.\n\tOptionBestEffort = \"BEST-EFFORT\"\n)\n```\n\n```\nconst (\n PortActionAdd = [iota](/builtin#iota)\n PortActionRemove\n)\n```\nPortAction values.\n\n```\nconst (\n // PropLocalAddr expresses a local address. For dialers, this is\n\t// the (often random) address that was locally bound. For listeners,\n\t// it is usually the service address. The value is a net.Addr.\n\tPropLocalAddr = \"LOCAL-ADDR\"\n\n // PropRemoteAddr expresses a remote address. For dialers, this is\n\t// the service address. For listeners, its the address of the far\n\t// end dialer. The value is a net.Addr.\n\tPropRemoteAddr = \"REMOTE-ADDR\"\n\n // PropTLSConnState is used to supply TLS connection details. The\n\t// value is a tls.ConnectionState. It is only valid when TLS is used.\n\tPropTLSConnState = \"TLS-STATE\"\n\n // PropHTTPRequest conveys an *http.Request. This property only exists\n\t// for websocket connections.\n\tPropHTTPRequest = \"HTTP-REQUEST\"\n)\n```\n\n```\nconst (\n ProtoPair = (1 * 16)\n ProtoPub = (2 * 16)\n ProtoSub = (2 * 16) + 1\n ProtoReq = (3 * 16)\n ProtoRep = (3 * 16) + 1\n ProtoPush = (5 * 16)\n ProtoPull = (5 * 16) + 1\n ProtoSurveyor = (6 * 16) + 2\n ProtoRespondent = (6 * 16) + 3\n ProtoBus = (7 * 16)\n\n ProtoStar = (100 * 16)\n)\n```\nUseful constants for protocol numbers. Note that the major protocol number is stored in the upper 12 bits, and the minor (subprotocol) is located in the bottom 4 bits.\n\n### Variables [¶](#pkg-variables)\n\n```\nvar (\n ErrBadAddr = [errors](/errors).[New](/errors#New)(\"invalid address\")\n ErrBadHeader = [errors](/errors).[New](/errors#New)(\"invalid header received\")\n ErrBadVersion = [errors](/errors).[New](/errors#New)(\"invalid protocol version\")\n ErrTooShort = [errors](/errors).[New](/errors#New)(\"message is too short\")\n ErrTooLong = [errors](/errors).[New](/errors#New)(\"message is too long\")\n ErrClosed = [errors](/errors).[New](/errors#New)(\"connection closed\")\n ErrConnRefused = [errors](/errors).[New](/errors#New)(\"connection refused\")\n ErrSendTimeout = [errors](/errors).[New](/errors#New)(\"send time out\")\n ErrRecvTimeout = [errors](/errors).[New](/errors#New)(\"receive time out\")\n ErrProtoState = [errors](/errors).[New](/errors#New)(\"incorrect protocol state\")\n ErrProtoOp = [errors](/errors).[New](/errors#New)(\"invalid operation for protocol\")\n ErrBadTran = [errors](/errors).[New](/errors#New)(\"invalid or unsupported transport\")\n ErrBadProto = [errors](/errors).[New](/errors#New)(\"invalid or unsupported protocol\")\n ErrPipeFull = [errors](/errors).[New](/errors#New)(\"pipe full\")\n ErrPipeEmpty = [errors](/errors).[New](/errors#New)(\"pipe empty\")\n ErrBadOption = [errors](/errors).[New](/errors#New)(\"invalid or unsupported option\")\n ErrBadValue = [errors](/errors).[New](/errors#New)(\"invalid option value\")\n ErrGarbled = [errors](/errors).[New](/errors#New)(\"message garbled\")\n ErrAddrInUse = [errors](/errors).[New](/errors#New)(\"address in use\")\n ErrBadProperty = [errors](/errors).[New](/errors#New)(\"invalid property name\")\n ErrTLSNoConfig = [errors](/errors).[New](/errors#New)(\"missing TLS configuration\")\n ErrTLSNoCert = [errors](/errors).[New](/errors#New)(\"missing TLS certificates\")\n)\n```\nVarious error codes.\n\n### Functions [¶](#pkg-functions)\n\n#### \nfunc [Device](https://github.com/go-mangos/mangos/blob/v1.4.0/device.go#L30) [¶](#Device)\n```\nfunc Device(s1 [Socket](#Socket), s2 [Socket](#Socket)) [error](/builtin#error)\n```\nDevice is used to create a forwarding loop between two sockets. If the same socket is listed (or either socket is nil), then a loopback device is established instead. Note that the single socket case is only valid for protocols where the underlying protocol can peer for itself (e.g. PAIR,\nor BUS, but not REQ/REP or PUB/SUB!) Both sockets will be placed into RAW mode.\n\nIf the plumbing is successful, nil will be returned. Two threads will be established to forward messages in each direction. If either socket returns error on receive or send, the goroutine doing the forwarding will exit.\nThis means that closing either socket will generally cause the goroutines to exit. Apart from closing the socket(s), no further operations should be performed against the socket.\n\n#### \nfunc [DrainChannel](https://github.com/go-mangos/mangos/blob/v1.4.0/util.go#L58) [¶](#DrainChannel)\n\nadded in v1.2.0\n```\nfunc DrainChannel(ch chan<- *[Message](#Message), expire [time](/time).[Time](/time#Time)) [bool](/builtin#bool)\n```\nDrainChannel waits for the channel of Messages to finish emptying (draining) for up to the expiration. It returns true if the drain completed (the channel is empty), false otherwise.\n\n#### \nfunc [NullRecv](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L213) [¶](#NullRecv)\n\nadded in v1.2.0\n```\nfunc NullRecv(ep [Endpoint](#Endpoint))\n```\nNullRecv simply loops, receiving and discarding messages, until the Endpoint returns back a nil message. This allows the Endpoint to notice a dropped connection. It is intended for use by Protocols that are write only -- it lets them become aware of a loss of connectivity even when they have no data to send.\n\n#### \nfunc [ProtocolName](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L180) [¶](#ProtocolName)\n```\nfunc ProtocolName(number [uint16](/builtin#uint16)) [string](/builtin#string)\n```\nProtocolName returns the name corresponding to a given protocol number.\nThis is useful for transports like WebSocket, which use a text name rather than the number in the handshake.\n\n#### \nfunc [ResolveTCPAddr](https://github.com/go-mangos/mangos/blob/v1.4.0/transport.go#L157) [¶](#ResolveTCPAddr)\n\nadded in v1.2.0\n```\nfunc ResolveTCPAddr(addr [string](/builtin#string)) (*[net](/net).[TCPAddr](/net#TCPAddr), [error](/builtin#error))\n```\nResolveTCPAddr is like net.ResolveTCPAddr, but it handles the wildcard used in nanomsg URLs, replacing it with an empty string to indicate that all local interfaces be used.\n\n#### \nfunc [StripScheme](https://github.com/go-mangos/mangos/blob/v1.4.0/transport.go#L147) [¶](#StripScheme)\n```\nfunc StripScheme(t [Transport](#Transport), addr [string](/builtin#string)) ([string](/builtin#string), [error](/builtin#error))\n```\nStripScheme removes the leading scheme (such as \"http://\") from an address string. This is mostly a utility for benefit of transport providers.\n\n#### \nfunc [ValidPeers](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L198) [¶](#ValidPeers)\n```\nfunc ValidPeers(p1, p2 [Protocol](#Protocol)) [bool](/builtin#bool)\n```\nValidPeers returns true if the two sockets are capable of peering to one another. For example, REQ can peer with REP,\nbut not with BUS.\n\n### Types [¶](#pkg-types)\n\n#### \ntype [CondTimed](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L23) [¶](#CondTimed)\n```\ntype CondTimed struct {\n [sync](/sync).[Cond](/sync#Cond)\n}\n```\nCondTimed is a condition variable (ala sync.Cond) but inclues a timeout.\n\n#### \nfunc (*CondTimed) [WaitAbsTimeout](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L43) [¶](#CondTimed.WaitAbsTimeout)\n```\nfunc (cv *[CondTimed](#CondTimed)) WaitAbsTimeout(when [time](/time).[Time](/time#Time)) [bool](/builtin#bool)\n```\nWaitAbsTimeout is like WaitRelTimeout, but expires on an absolute time instead of a relative one.\n\n#### \nfunc (*CondTimed) [WaitRelTimeout](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L31) [¶](#CondTimed.WaitRelTimeout)\n```\nfunc (cv *[CondTimed](#CondTimed)) WaitRelTimeout(when [time](/time).[Duration](/time#Duration)) [bool](/builtin#bool)\n```\nWaitRelTimeout is like Wait, but it times out. The fact that it timed out can be determined by checking the return value. True indicates that it woke up without a timeout (signaled another way),\nwhereas false indicates a timeout occurred.\n\n#### \ntype [Dialer](https://github.com/go-mangos/mangos/blob/v1.4.0/dialer.go#L19) [¶](#Dialer)\n```\ntype Dialer interface {\n // Close closes the dialer, and removes it from any active socket.\n\t// Further operations on the Dialer will return ErrClosed.\n\tClose() [error](/builtin#error)\n\n // Dial starts connecting on the address. If a connection fails,\n\t// it will restart.\n\tDial() [error](/builtin#error)\n\n // Address returns the string (full URL) of the Listener.\n\tAddress() [string](/builtin#string)\n\n // SetOption sets an option the Listener. Setting options\n\t// can only be done before Listen() has been called.\n\tSetOption(name [string](/builtin#string), value interface{}) [error](/builtin#error)\n\n // GetOption gets an option value from the Listener.\n\tGetOption(name [string](/builtin#string)) (interface{}, [error](/builtin#error))\n}\n```\nDialer is an interface to the underlying dialer for a transport and address.\n\n#### \ntype [Endpoint](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L24) [¶](#Endpoint)\n```\ntype Endpoint interface {\n // GetID returns a unique 31-bit value associated with the Endpoint.\n\t// The value is unique for a given socket, at a given time.\n\tGetID() [uint32](/builtin#uint32)\n\n // Close does what you think.\n\tClose() [error](/builtin#error)\n\n // SendMsg sends a message. On success it returns nil. This is a\n\t// blocking call.\n\tSendMsg(*[Message](#Message)) [error](/builtin#error)\n\n // RecvMsg receives a message. It blocks until the message is\n\t// received. On error, the pipe is closed and nil is returned.\n\tRecvMsg() *[Message](#Message)\n}\n```\nEndpoint represents the handle that a Protocol implementation has to the underlying stream transport. It can be thought of as one side of a TCP, IPC, or other type of connection.\n\n#### \ntype [Listener](https://github.com/go-mangos/mangos/blob/v1.4.0/listener.go#L19) [¶](#Listener)\n```\ntype Listener interface {\n // Close closes the listener, and removes it from any active socket.\n\t// Further operations on the Listener will return ErrClosed.\n\tClose() [error](/builtin#error)\n\n // Listen starts listening for new connectons on the address.\n\tListen() [error](/builtin#error)\n\n // Address returns the string (full URL) of the Listener.\n\tAddress() [string](/builtin#string)\n\n // SetOption sets an option the Listener. Setting options\n\t// can only be done before Listen() has been called.\n\tSetOption(name [string](/builtin#string), value interface{}) [error](/builtin#error)\n\n // GetOption gets an option value from the Listener.\n\tGetOption(name [string](/builtin#string)) (interface{}, [error](/builtin#error))\n}\n```\nListener is an interface to the underlying listener for a transport and address.\n\n#### \ntype [Message](https://github.com/go-mangos/mangos/blob/v1.4.0/message.go#L28) [¶](#Message)\n```\ntype Message struct {\n // Header carries any protocol (SP) specific header. Applications\n\t// should not modify or use this unless they are using Raw mode.\n\t// No user data may be placed here.\n\tHeader [][byte](/builtin#byte)\n\n // Body carries the body of the message. This can also be thought\n\t// of as the message \"payload\".\n\tBody [][byte](/builtin#byte)\n\n // Port may be set on message receipt, to indicate the Port from\n\t// which the Message was received. There are no guarantees that the\n\t// Port is still active, and applications should only use this for\n\t// informational purposes.\n\tPort [Port](#Port)\n\t// contains filtered or unexported fields\n}\n```\nMessage encapsulates the messages that we exchange back and forth. The meaning of the Header and Body fields, and where the splits occur, will vary depending on the protocol. Note however that any headers applied by transport layers (including TCP/ethernet headers, and SP protocol independent length headers), are *not* included in the Header.\n\n#### \nfunc [NewMessage](https://github.com/go-mangos/mangos/blob/v1.4.0/message.go#L156) [¶](#NewMessage)\n```\nfunc NewMessage(sz [int](/builtin#int)) *[Message](#Message)\n```\nNewMessage is the supported way to obtain a new Message. This makes use of a \"cache\" which greatly reduces the load on the garbage collector.\n\n#### \nfunc (*Message) [Dup](https://github.com/go-mangos/mangos/blob/v1.4.0/message.go#L134) [¶](#Message.Dup)\n```\nfunc (m *[Message](#Message)) Dup() *[Message](#Message)\n```\nDup creates a \"duplicate\" message. What it really does is simply increment the reference count on the message. Note that since the underlying message is actually shared, consumers must take care not to modify the message. (We might revise this API in the future to add a copy-on-write facility, but for now modification is neither needed nor supported.) Applications should *NOT* make use of this function -- it is intended for Protocol, Transport and internal use only.\n\n#### \nfunc (*Message) [Expired](https://github.com/go-mangos/mangos/blob/v1.4.0/message.go#L144) [¶](#Message.Expired)\n\nadded in v1.2.0\n```\nfunc (m *[Message](#Message)) Expired() [bool](/builtin#bool)\n```\nExpired returns true if the message has \"expired\". This is used by transport implementations to discard messages that have been stuck in the write queue for too long, and should be discarded rather than delivered across the transport. This is only used on the TX path, there is no sense of \"expiration\" on the RX path.\n\n#### \nfunc (*Message) [Free](https://github.com/go-mangos/mangos/blob/v1.4.0/message.go#L115) [¶](#Message.Free)\n```\nfunc (m *[Message](#Message)) Free()\n```\nFree decrements the reference count on a message, and releases its resources if no further references remain. While this is not strictly necessary thanks to GC, doing so allows for the resources to be recycled without engaging GC. This can have rather substantial benefits for performance.\n\n#### \ntype [Pipe](https://github.com/go-mangos/mangos/blob/v1.4.0/transport.go#L29) [¶](#Pipe)\n```\ntype Pipe interface {\n\n // Send sends a complete message. In the event of a partial send,\n\t// the Pipe will be closed, and an error is returned. For reasons\n\t// of efficiency, we allow the message to be sent in a scatter/gather\n\t// list.\n\tSend(*[Message](#Message)) [error](/builtin#error)\n\n // Recv receives a complete message. In the event that either a\n\t// complete message could not be received, an error is returned\n\t// to the caller and the Pipe is closed.\n\t//\n\t// To mitigate Denial-of-Service attacks, we limit the max message\n\t// size to 1M.\n\tRecv() (*[Message](#Message), [error](/builtin#error))\n\n // Close closes the underlying transport. Further operations on\n\t// the Pipe will result in errors. Note that messages that are\n\t// queued in transport buffers may still be received by the remote\n\t// peer.\n\tClose() [error](/builtin#error)\n\n // LocalProtocol returns the 16-bit SP protocol number used by the\n\t// local side. This will normally be sent to the peer during\n\t// connection establishment.\n\tLocalProtocol() [uint16](/builtin#uint16)\n\n // RemoteProtocol returns the 16-bit SP protocol number used by the\n\t// remote side. This will normally be received from the peer during\n\t// connection establishment.\n\tRemoteProtocol() [uint16](/builtin#uint16)\n\n // IsOpen returns true if the underlying connection is open.\n\tIsOpen() [bool](/builtin#bool)\n\n // GetProp returns an arbitrary transport specific property.\n\t// These are like options, but are read-only and specific to a single\n\t// connection. If the property doesn't exist, then ErrBadProperty\n\t// should be returned.\n\tGetProp([string](/builtin#string)) (interface{}, [error](/builtin#error))\n}\n```\nPipe behaves like a full-duplex message-oriented connection between two peers. Callers may call operations on a Pipe simultaneously from different goroutines. (These are different from net.Conn because they provide message oriented semantics.)\n\nPipe is only intended for use by transport implementors, and should not be directly used in applications.\n\n#### \nfunc [NewConnPipe](https://github.com/go-mangos/mangos/blob/v1.4.0/conn.go#L138) [¶](#NewConnPipe)\n```\nfunc NewConnPipe(c [net](/net).[Conn](/net#Conn), sock [Socket](#Socket), props ...interface{}) ([Pipe](#Pipe), [error](/builtin#error))\n```\nNewConnPipe allocates a new Pipe using the supplied net.Conn, and initializes it. It performs the handshake required at the SP layer,\nonly returning the Pipe once the SP layer negotiation is complete.\n\nStream oriented transports can utilize this to implement a Transport.\nThe implementation will also need to implement PipeDialer, PipeAccepter,\nand the Transport enclosing structure. Using this layered interface,\nthe implementation needn't bother concerning itself with passing actual SP messages once the lower layer connection is established.\n\n#### \nfunc [NewConnPipeIPC](https://github.com/go-mangos/mangos/blob/v1.4.0/connipc_posix.go#L26) [¶](#NewConnPipeIPC)\n```\nfunc NewConnPipeIPC(c [net](/net).[Conn](/net#Conn), sock [Socket](#Socket), props ...interface{}) ([Pipe](#Pipe), [error](/builtin#error))\n```\nNewConnPipeIPC allocates a new Pipe using the IPC exchange protocol.\n\n#### \ntype [PipeDialer](https://github.com/go-mangos/mangos/blob/v1.4.0/transport.go#L76) [¶](#PipeDialer)\n```\ntype PipeDialer interface {\n // Dial is used to initiate a connection to a remote peer.\n\tDial() ([Pipe](#Pipe), [error](/builtin#error))\n\n // SetOption sets a local option on the dialer.\n\t// ErrBadOption can be returned for unrecognized options.\n\t// ErrBadValue can be returned for incorrect value types.\n\tSetOption(name [string](/builtin#string), value interface{}) [error](/builtin#error)\n\n // GetOption gets a local option from the dialer.\n\t// ErrBadOption can be returned for unrecognized options.\n\tGetOption(name [string](/builtin#string)) (value interface{}, err [error](/builtin#error))\n}\n```\nPipeDialer represents the client side of a connection. Clients initiate the connection.\n\nPipeDialer is only intended for use by transport implementors, and should not be directly used in applications.\n\n#### \ntype [PipeListener](https://github.com/go-mangos/mangos/blob/v1.4.0/transport.go#L95) [¶](#PipeListener)\n```\ntype PipeListener interface {\n\n // Listen actually begins listening on the interface. It is\n\t// called just prior to the Accept() routine normally. It is\n\t// the socket equivalent of bind()+listen().\n\tListen() [error](/builtin#error)\n\n // Accept completes the server side of a connection. Once the\n\t// connection is established and initial handshaking is complete,\n\t// the resulting connection is returned to the client.\n\tAccept() ([Pipe](#Pipe), [error](/builtin#error))\n\n // Close ceases any listening activity, and will specifically close\n\t// any underlying file descriptor. Once this is done, the only way\n\t// to resume listening is to create a new Server instance. Presumably\n\t// this function is only called when the last reference to the server\n\t// is about to go away. Established connections are unaffected.\n\tClose() [error](/builtin#error)\n\n // SetOption sets a local option on the listener.\n\t// ErrBadOption can be returned for unrecognized options.\n\t// ErrBadValue can be returned for incorrect value types.\n\tSetOption(name [string](/builtin#string), value interface{}) [error](/builtin#error)\n\n // GetOption gets a local option from the listener.\n\t// ErrBadOption can be returned for unrecognized options.\n\tGetOption(name [string](/builtin#string)) (value interface{}, err [error](/builtin#error))\n\n // Address gets the local address. The value may not be meaningful\n\t// until Listen() has been called.\n\tAddress() [string](/builtin#string)\n}\n```\nPipeListener represents the server side of a connection. Servers respond to a connection request from clients.\n\nPipeListener is only intended for use by transport implementors, and should not be directly used in applications.\n\n#### \ntype [Port](https://github.com/go-mangos/mangos/blob/v1.4.0/port.go#L22) [¶](#Port)\n```\ntype Port interface {\n\n // Address returns the address (URL form) associated with the port.\n\t// This matches the string passed to Dial() or Listen().\n\tAddress() [string](/builtin#string)\n\n // GetProp returns an arbitrary property. The details will vary\n\t// for different transport types.\n\tGetProp(name [string](/builtin#string)) (interface{}, [error](/builtin#error))\n\n // IsOpen determines whether this is open or not.\n\tIsOpen() [bool](/builtin#bool)\n\n // Close closes the Conn. This does a disconnect, or something similar.\n\t// Note that if a dialer is present and active, it will redial.\n\tClose() [error](/builtin#error)\n\n // IsServer returns true if the connection is from a server (Listen).\n\tIsServer() [bool](/builtin#bool)\n\n // IsClient returns true if the connection is from a client (Dial).\n\tIsClient() [bool](/builtin#bool)\n\n // LocalProtocol returns the local protocol number.\n\tLocalProtocol() [uint16](/builtin#uint16)\n\n // RemoteProtocol returns the remote protocol number.\n\tRemoteProtocol() [uint16](/builtin#uint16)\n\n // Dialer returns the dialer for this Port, or nil if a server.\n\tDialer() [Dialer](#Dialer)\n\n // Listener returns the listener for this Port, or nil if a client.\n\tListener() [Listener](#Listener)\n}\n```\nPort represents the high level interface to a low level communications channel. There is one of these associated with a given TCP connection,\nfor example. This interface is intended for application use.\n\nNote that applicatons cannot send or receive data on a Port directly.\n\n#### \ntype [PortAction](https://github.com/go-mangos/mangos/blob/v1.4.0/port.go#L59) [¶](#PortAction)\n```\ntype PortAction [int](/builtin#int)\n```\nPortAction determines whether the action on a Port is addition or removal.\n\n#### \ntype [PortHook](https://github.com/go-mangos/mangos/blob/v1.4.0/port.go#L70) [¶](#PortHook)\n```\ntype PortHook func([PortAction](#PortAction), [Port](#Port)) [bool](/builtin#bool)\n```\nPortHook is a function that is called when a port is added or removed to or from a Socket. In the case of PortActionAdd, the function may return false to indicate that the port should not be added.\n\n#### \ntype [Protocol](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L44) [¶](#Protocol)\n```\ntype Protocol interface {\n\n // Init is called by the core to allow the protocol to perform\n\t// any initialization steps it needs. It should save the handle\n\t// for future use, as well.\n\tInit([ProtocolSocket](#ProtocolSocket))\n\n // Shutdown is used to drain the send side. It is only ever called\n\t// when the socket is being shutdown cleanly. Protocols should use\n\t// the linger time, and wait up to that time for sockets to drain.\n\tShutdown([time](/time).[Time](/time#Time))\n\n // AddEndpoint is called when a new Endpoint is added to the socket.\n\t// Typically this is as a result of connect or accept completing.\n\tAddEndpoint([Endpoint](#Endpoint))\n\n // RemoveEndpoint is called when an Endpoint is removed from the socket.\n\t// Typically this indicates a disconnected or closed connection.\n\tRemoveEndpoint([Endpoint](#Endpoint))\n\n // ProtocolNumber returns a 16-bit value for the protocol number,\n\t// as assigned by the SP governing body. (IANA?)\n\tNumber() [uint16](/builtin#uint16)\n\n // Name returns our name.\n\tName() [string](/builtin#string)\n\n // PeerNumber() returns a 16-bit number for our peer protocol.\n\tPeerNumber() [uint16](/builtin#uint16)\n\n // PeerName() returns the name of our peer protocol.\n\tPeerName() [string](/builtin#string)\n\n // GetOption is used to retrieve the current value of an option.\n\t// If the protocol doesn't recognize the option, EBadOption should\n\t// be returned.\n\tGetOption([string](/builtin#string)) (interface{}, [error](/builtin#error))\n\n // SetOption is used to set an option. EBadOption is returned if\n\t// the option name is not recognized, EBadValue if the value is\n\t// invalid.\n\tSetOption([string](/builtin#string), interface{}) [error](/builtin#error)\n}\n```\nProtocol implementations handle the \"meat\" of protocol processing. Each protocol type will implement one of these. For protocol pairs (REP/REQ),\nthere will be one for each half of the protocol.\n\n#### \ntype [ProtocolRecvHook](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L92) [¶](#ProtocolRecvHook)\n```\ntype ProtocolRecvHook interface {\n // RecvHook is called just before the message is handed to the\n\t// application. The message may be modified. If false is returned,\n\t// then the message is dropped.\n\tRecvHook(*[Message](#Message)) [bool](/builtin#bool)\n}\n```\nProtocolRecvHook is intended to be an additional extension to the Protocol interface.\n\n#### \ntype [ProtocolSendHook](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L101) [¶](#ProtocolSendHook)\n```\ntype ProtocolSendHook interface {\n // SendHook is called when the application calls Send.\n\t// If false is returned, the message will be silently dropped.\n\t// Note that the message may be dropped for other reasons,\n\t// such as if backpressure is applied.\n\tSendHook(*[Message](#Message)) [bool](/builtin#bool)\n}\n```\nProtocolSendHook is intended to be an additional extension to the Protocol interface.\n\n#### \ntype [ProtocolSocket](https://github.com/go-mangos/mangos/blob/v1.4.0/protocol.go#L113) [¶](#ProtocolSocket)\n```\ntype ProtocolSocket interface {\n // SendChannel represents the channel used to send messages. The\n\t// application injects messages to it, and the protocol consumes\n\t// messages from it. The channel may be closed when the core needs to\n\t// create a new channel, typically after an option is set that requires\n\t// the channel to be reconfigured. (OptionWriteQLen) When the protocol\n\t// implementation notices this, it should call this function again to obtain\n\t// the value of the new channel.\n\tSendChannel() <-chan *[Message](#Message)\n\n // RecvChannel is the channel used to receive messages. The protocol\n\t// should inject messages to it, and the application will consume them\n\t// later.\n\tRecvChannel() chan<- *[Message](#Message)\n\n // The protocol can wait on this channel to close. When it is closed,\n\t// it indicates that the application has closed the upper read socket,\n\t// and the protocol should stop any further read operations on this\n\t// instance.\n\tCloseChannel() <-chan struct{}\n\n // GetOption may be used by the protocol to retrieve an option from\n\t// the socket. This can ultimately wind up calling into the socket's\n\t// own GetOption handler, so care should be used!\n\tGetOption([string](/builtin#string)) (interface{}, [error](/builtin#error))\n\n // SetOption is used by the Protocol to set an option on the socket.\n\t// Note that this may set transport options, or even call back down\n\t// into the protocol's own SetOption interface!\n\tSetOption([string](/builtin#string), interface{}) [error](/builtin#error)\n\n // SetRecvError is used to cause socket RX callers to report an\n\t// error. This can be used to force an error return rather than\n\t// waiting for a message that will never arrive (e.g. due to state).\n\t// If set to nil, then RX works normally.\n\tSetRecvError([error](/builtin#error))\n\n // SetSendError is used to cause socket TX callers to report an\n\t// error. This can be used to force an error return rather than\n\t// waiting to send a message that will never be delivered (e.g. due\n\t// to incorrect state.) If set to nil, then TX works normally.\n\tSetSendError([error](/builtin#error))\n}\n```\nProtocolSocket is the \"handle\" given to protocols to interface with the socket. The Protocol implementation should not access any sockets or pipes except by using functions made available on the ProtocolSocket. Note that all functions listed here are non-blocking.\n\n#### \ntype [Socket](https://github.com/go-mangos/mangos/blob/v1.4.0/socket.go#L21) [¶](#Socket)\n```\ntype Socket interface {\n // Close closes the open Socket. Further operations on the socket\n\t// will return ErrClosed.\n\tClose() [error](/builtin#error)\n\n // Send puts the message on the outbound send queue. It blocks\n\t// until the message can be queued, or the send deadline expires.\n\t// If a queued message is later dropped for any reason,\n\t// there will be no notification back to the application.\n\tSend([][byte](/builtin#byte)) [error](/builtin#error)\n\n // Recv receives a complete message. The entire message is received.\n\tRecv() ([][byte](/builtin#byte), [error](/builtin#error))\n\n // SendMsg puts the message on the outbound send. It works like Send,\n\t// but allows the caller to supply message headers. AGAIN, the Socket\n\t// ASSUMES OWNERSHIP OF THE MESSAGE.\n\tSendMsg(*[Message](#Message)) [error](/builtin#error)\n\n // RecvMsg receives a complete message, including the message header,\n\t// which is useful for protocols in raw mode.\n\tRecvMsg() (*[Message](#Message), [error](/builtin#error))\n\n // Dial connects a remote endpoint to the Socket. The function\n\t// returns immediately, and an asynchronous goroutine is started to\n\t// establish and maintain the connection, reconnecting as needed.\n\t// If the address is invalid, then an error is returned.\n\tDial(addr [string](/builtin#string)) [error](/builtin#error)\n\n DialOptions(addr [string](/builtin#string), options map[[string](/builtin#string)]interface{}) [error](/builtin#error)\n\n // NewDialer returns a Dialer object which can be used to get\n\t// access to the underlying configuration for dialing.\n\tNewDialer(addr [string](/builtin#string), options map[[string](/builtin#string)]interface{}) ([Dialer](#Dialer), [error](/builtin#error))\n\n // Listen connects a local endpoint to the Socket. Remote peers\n\t// may connect (e.g. with Dial) and will each be \"connected\" to\n\t// the Socket. The accepter logic is run in a separate goroutine.\n\t// The only error possible is if the address is invalid.\n\tListen(addr [string](/builtin#string)) [error](/builtin#error)\n\n ListenOptions(addr [string](/builtin#string), options map[[string](/builtin#string)]interface{}) [error](/builtin#error)\n\n NewListener(addr [string](/builtin#string), options map[[string](/builtin#string)]interface{}) ([Listener](#Listener), [error](/builtin#error))\n\n // GetOption is used to retrieve an option for a socket.\n\tGetOption(name [string](/builtin#string)) (interface{}, [error](/builtin#error))\n\n // SetOption is used to set an option for a socket.\n\tSetOption(name [string](/builtin#string), value interface{}) [error](/builtin#error)\n\n // Protocol is used to get the underlying Protocol.\n\tGetProtocol() [Protocol](#Protocol)\n\n // AddTransport adds a new Transport to the socket. Transport specific\n\t// options may have been configured on the Transport prior to this.\n\tAddTransport([Transport](#Transport))\n\n // SetPortHook sets a PortHook function to be called when a Port is\n\t// added or removed from this socket (connect/disconnect). The previous\n\t// hook is returned (nil if none.)\n\tSetPortHook([PortHook](#PortHook)) [PortHook](#PortHook)\n}\n```\nSocket is the main access handle applications use to access the SP system. It is an abstraction of an application's \"connection\" to a messaging topology. Applications can have more than one Socket open at a time.\n\n#### \nfunc [MakeSocket](https://github.com/go-mangos/mangos/blob/v1.4.0/core.go#L142) [¶](#MakeSocket)\n```\nfunc MakeSocket(proto [Protocol](#Protocol)) [Socket](#Socket)\n```\nMakeSocket is intended for use by Protocol implementations. The intention is that they can wrap this to provide a \"proto.NewSocket()\" implementation.\n\n#### \ntype [Transport](https://github.com/go-mangos/mangos/blob/v1.4.0/transport.go#L129) [¶](#Transport)\n```\ntype Transport interface {\n // Scheme returns a string used as the prefix for SP \"addresses\".\n\t// This is similar to a URI scheme. For example, schemes can be\n\t// \"tcp\" (for \"tcp://xxx...\"), \"ipc\", \"inproc\", etc.\n\tScheme() [string](/builtin#string)\n\n // NewDialer creates a new Dialer for this Transport.\n\tNewDialer(url [string](/builtin#string), sock [Socket](#Socket)) ([PipeDialer](#PipeDialer), [error](/builtin#error))\n\n // NewListener creates a new PipeListener for this Transport.\n\t// This generally also arranges for an OS-level file descriptor to be\n\t// opened, and bound to the the given address, as well as establishing\n\t// any \"listen\" backlog.\n\tNewListener(url [string](/builtin#string), sock [Socket](#Socket)) ([PipeListener](#PipeListener), [error](/builtin#error))\n}\n```\nTransport is the interface for transport suppliers to implement.\n\n#### \ntype [Waiter](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L53) [¶](#Waiter)\n```\ntype Waiter struct {\n [sync](/sync).[Mutex](/sync#Mutex)\n\t// contains filtered or unexported fields\n}\n```\nWaiter is a way to wait for completion, but it includes a timeout. It is similar in some respects to sync.WaitGroup.\n\n#### \nfunc (*Waiter) [Add](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L67) [¶](#Waiter.Add)\n```\nfunc (w *[Waiter](#Waiter)) Add()\n```\nAdd adds a new go routine/item to wait for. This should be called before starting go routines you want to wait for, for example.\n\n#### \nfunc (*Waiter) [Done](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L77) [¶](#Waiter.Done)\n```\nfunc (w *[Waiter](#Waiter)) Done()\n```\nDone is called when the item to wait for is done. There should be a one to one correspondance between Add and Done. When the count drops to zero,\nany callers blocked in Wait() are woken. If the count drops below zero,\nit panics.\n\n#### \nfunc (*Waiter) [Init](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L60) [¶](#Waiter.Init)\n```\nfunc (w *[Waiter](#Waiter)) Init()\n```\nInit must be called to initialize the Waiter.\n\n#### \nfunc (*Waiter) [Wait](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L91) [¶](#Waiter.Wait)\n```\nfunc (w *[Waiter](#Waiter)) Wait()\n```\nWait waits without a timeout. It only completes when the count drops to zero.\n\n#### \nfunc (*Waiter) [WaitAbsTimeout](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L114) [¶](#Waiter.WaitAbsTimeout)\n```\nfunc (w *[Waiter](#Waiter)) WaitAbsTimeout(t [time](/time).[Time](/time#Time)) [bool](/builtin#bool)\n```\nWaitAbsTimeout is like WaitRelTimeout, but waits until an absolute time.\n\n#### \nfunc (*Waiter) [WaitRelTimeout](https://github.com/go-mangos/mangos/blob/v1.4.0/waiter.go#L101) [¶](#Waiter.WaitRelTimeout)\n```\nfunc (w *[Waiter](#Waiter)) WaitRelTimeout(d [time](/time).[Duration](/time#Duration)) [bool](/builtin#bool)\n```\nWaitRelTimeout waits until either the count drops to zero, or the timeout expires. It returns true if the count is zero, false otherwise."}}},{"rowIdx":450,"cells":{"project":{"kind":"string","value":"SIT"},"source":{"kind":"string","value":"cran"},"language":{"kind":"string","value":"R"},"content":{"kind":"string","value":"Package ‘SIT’\n                                          December 20, 2022\nTitle Association Measurement Through Sliced Independence Test (SIT)\nVersion 0.1.0\nDescription Computes the sit coefficient between two vectors x and y,\n      possibly all paired coefficients for a matrix. The reference for the methods implemented here is\n      Zhang, Yilin, , and . 2022. ``Sliced Independence Test.'' Statis-\n      tica Sinica. .\n      This package incorporates the Galton peas example.\nLicense MIT + file LICENSE\nEncoding UTF-8\nRoxygenNote 7.2.1\nLinkingTo Rcpp, RcppArmadillo\nImports Rcpp, stats\nDate 2022-12-19\nSuggests ggplot2, psychTools\nNeedsCompilation yes\nAuthor  [aut, cre] ()\nMaintainer  <>\nRepository CRAN\nDate/Publication 2022-12-20 11:00:05 UTC\nR topics documented:\nblocksu... 2\ncalculateSI... 2\nsitco... 3\n  blocksum                     Compute the block-wise sum of a vector.\nDescription\n    Compute the block-wise sum of a vector.\nUsage\n    blocksum(r, c)\nArguments\n    r                  An integer vector\n    c                  The number of observations in each block\nValue\n    The function returns the block sum of the vector.\n  calculateSIT                 Compute the cross rank coefficient sit on two vectors.\nDescription\n    This function computes the sit coefficient between two vectors x and y.\nUsage\n    calculateSIT(x, y, c = 2)\nArguments\n    x                  Vector of numeric values in the first coordinate.\n    y                  Vector of numeric values in the second coordinate.\n    c                  The number of observations in each slice.\nValue\n    The function returns the value of the sit coefficient.\nNote\n    Auxiliary function with no checks for NA, etc.\nAuthor(s)\n     ,  & \nReferences\n     ., ., & . (2021). Sliced Independence Test. Statistica Sinica. https://doi.org/10.5705/ss.202021.0203.\nSee Also\n     sitcor\nExamples\n     # Compute one of the coefficients\n     library(\"psychTools\")\n     data(peas)\n     calculateSIT(peas$parent,peas$child)\n     calculateSIT(peas$child,peas$parent)\n   sitcor                        Conduct the sliced independence test.\nDescription\n     This function computes the sit coefficient between two vectors x and y, possibly all paired coeffi-\n     cients for a matrix.\nUsage\n     sitcor(\n        x,\n        y = NULL,\n        c = 2,\n        pvalue = FALSE,\n        ties = FALSE,\n        method = \"asymptotic\",\n        nperm = 199,\n        factor = FALSE\n     )\nArguments\n     x                    Vector of numeric values in the first coordinate.\n     y                    Vector of numeric values in the second coordinate.\n     c                    The number of observations in each slice.\n     pvalue               Whether or not to return the p-value of rejecting independence, if TRUE the\n                          function also returns the standard deviation of sit.\n    ties                Do we need to handle ties? If ties=TRUE the algorithm assumes that the data\n                        has ties and employs the more elaborated theory for calculating s.d. and P-value.\n                        Otherwise, it uses the simpler theory. There is no harm in putting ties = TRUE\n                        even if there are no ties.\n    method              If method = \"asymptotic\" the function returns P-values computed by the asymp-\n                        totic theory (not available in the presence of ties). If method = \"permutation\", a\n                        permutation test with nperm permutations is employed to estimate the P-value.\n                        Usually, there is no need for the permutation test. The asymptotic theory is good\n                        enough.\n    nperm               In the case of a permutation test, nperm is the number of permutations to do.\n    factor              Whether to transform integers into factors, the default is to leave them alone.\nValue\n    In the case pvalue=FALSE, function returns the value of the sit coefficient, if the input is a matrix,\n    a matrix of coefficients is returned. In the case pvalue=TRUE is chosen, the function returns a list:\n    sitcor The value of the sit coefficient.\n    sd The standard deviation.\n    pval The test p-value.\nAuthor(s)\n    ,  & \nReferences\n    ., ., & . (2022). Sliced Independence Test. Statistica Sinica. https://doi.org/10.5705/ss.202021.0203.\nExamples\n    ##---- Should be DIRECTLY executable !! ----\n    library(\"psychTools\")\n    data(peas)\n    # Visualize          the peas data\n    library(ggplot2)\n    ggplot(peas,aes(parent,child)) +\n    geom_count() + scale_radius(range=c(0,5)) +\n            xlim(c(13.5,24))+ylim(c(13.5,24))+               coord_fixed() +\n            theme(legend.position=\"bottom\")\n    # Compute one of the coefficients\n    sitcor(peas$parent,peas$child, c = 4, pvalue=TRUE)\n    sitcor(peas$child,peas$parent, c = 4)\n    # Compute all the coefficients\n    sitcor(peas, c = 4)"}}},{"rowIdx":451,"cells":{"project":{"kind":"string","value":"phylopath"},"source":{"kind":"string","value":"cran"},"language":{"kind":"string","value":"R"},"content":{"kind":"string","value":"Package ‘phylopath’\n                                         October 10, 2023\nType Package\nTitle Perform Phylogenetic Path Analysis\nVersion 1.2.0\nMaintainer  <>\nDescription A comprehensive and easy to use R implementation of confirmatory\n      phylogenetic path analysis as described by  and Gonzalez-Voyer\n      (2012) .\nURL https://Ax3man.github.io/phylopath/\nBugReports https://github.com/Ax3man/phylopath/issues\nLicense GPL-3\nLazyData TRUE\nDepends R (>= 2.10)\nImports ape (>= 4.1), future.apply, ggm (>= 2.3), ggplot2 (>= 3.0.0),\n      ggraph (>= 1.0.0), igraph (>= 1.0.1), MuMIn (>= 1.15.6),\n      phylolm (>= 2.5), purrr (>= 0.2.3), tibble\nRoxygenNote 7.2.3\nSuggests knitr, rmarkdown, testthat\nVignetteBuilder knitr\nEncoding UTF-8\nNeedsCompilation no\nAuthor  [aut, cre]\nRepository CRAN\nDate/Publication 2023-10-09 23:10:03 UTC\nR topics documented:\naverag... 2\naverage_DAG... 3\nbes... 4\nchoic... 5\ncichlid... 6\ncichlids_tre... 7\ncoef_plo... 7\nDA... 8\ndefine_model_se... 9\nest_DA... 10\nphylo_pat... 11\nplot.DA... 13\nplot.fitted_DA... 15\nplot_model_se... 16\nred_lis... 18\nred_list_tre... 19\nrhin... 19\nrhino_tre... 20\nshow_warning... 20\n  average                       Extract and average the best supported models from a phylogenetic\n                                path analysis.\nDescription\n    Extract and average the best supported models from a phylogenetic path analysis.\nUsage\n    average(phylopath, cut_off = 2, avg_method = \"conditional\", ...)\nArguments\n    phylopath           An object of class phylopath.\n    cut_off             The CICc cut-off used to select the best models. Use Inf to average over all\n                        models. Use the best() function to only use the top model, or choice() to\n                        select any single model.\n    avg_method          Either \"full\" or \"conditional\". The methods differ in how they deal with\n                        averaging a path coefficient where the path is absent in some of the models.\n                        The full method sets the coefficient (and the variance) for the missing paths\n                        to zero, meaning paths that are missing in some models will shrink towards\n                        zero. The conditional method only averages over models where the path ap-\n                        pears, making it more sensitive to small effects. Following von Hardenberg\n                        & Gonzalez-Voyer 2013, conditional averaging is set as the default. Also see\n                        MuMIn::model.avg().\n    ...                 Arguments to pass to phylolm::phylolm and phylolm::phyloglm. Provide boot\n                        = K parameter to enable bootstrapping, where K is the number of bootstrap repli-\n                        cates. If you specified other options in the original phylo_path call you don’t\n                        need to specify them again.\nValue\n    An object of class fitted_DAG.\nExamples\n      candidates <- define_model_set(\n        A = NL ~ RS,\n        B = RS ~ NL + BM,\n        .common = c(LS ~ BM, DD ~ NL, NL ~ BM)\n      )\n      p <- phylo_path(candidates, rhino, rhino_tree)\n      summary(p)\n      # Models A and B have similar support, so we may decide to take\n      # their average.\n      avg_model <- average(p)\n      # Print the average model to see coefficients, se and ci:\n      avg_model\n      ## Not run:\n      # Plot to show the weighted graph:\n      plot(avg_model)\n      # One can see that an averaged model is not necessarily a DAG itself.\n      # This model actually has a path in two directions.\n      # Note that coefficients that only occur in one of the models become much\n      # smaller when we use full averaging:\n      coef_plot(avg_model)\n      coef_plot(average(p, method = 'full'))\n    ## End(Not run)\n  average_DAGs               Perform model averaging on a list of DAGs.\nDescription\n    Perform model averaging on a list of DAGs.\nUsage\n    average_DAGs(\n      fitted_DAGs,\n      weights = rep(1, length(coef)),\n      avg_method = \"conditional\",\n      ...\n    )\nArguments\n    fitted_DAGs         A list of fitted_DAG objects containing coefficients and standard errors, usually\n                        obtained by using est_DAG() on several DAGs.\n    weights             A vector of associated model weights.\n    avg_method          Either \"full\" or \"conditional\". The methods differ in how they deal with\n                        averaging a path coefficient where the path is absent in some of the models.\n                        The full method sets the coefficient (and the variance) for the missing paths\n                        to zero, meaning paths that are missing in some models will shrink towards\n                        zero. The conditional method only averages over models where the path ap-\n                        pears, making it more sensitive to small effects. Following \n                        & Gonzalez-Voyer 2013, conditional averaging is set as the default. Also see\n                        MuMIn::model.avg().\n    ...                 Additional arguments passed to MuMIn::par.avg().\n                        For details on the error calculations, see MuMIn::par.avg().\nValue\n    An object of class fitted_DAG, including standard errors and confidence intervals.\nExamples\n      # Normally, I would advocate the use of the phylo_path and average\n      # functions, but this code shows how to average any set of models. Note\n      # that not many checks are implemented, so you may want to be careful and\n      # make sure the DAGs make sense and contain the same variables!\n      candidates <- define_model_set(\n        A = NL ~ BM,\n        B = NL ~ LS,\n        .common = c(LS ~ BM, DD ~ NL)\n      )\n      fit_cand <- lapply(candidates, est_DAG, rhino, rhino_tree,\n                             model = 'lambda', method = 'logistic_MPLE')\n      ave_cand <- average_DAGs(fit_cand)\n      coef_plot(ave_cand)\n  best                          Extract and estimate the best supported model from a phylogenetic\n                                path analysis.\nDescription\n    Extract and estimate the best supported model from a phylogenetic path analysis.\nUsage\n    best(phylopath, ...)\nArguments\n    phylopath           An object of class phylopath.\n    ...                 Arguments to pass to phylolm::phylolm and phylolm::phyloglm. Provide boot\n                        = K parameter to enable bootstrapping, where K is the number of bootstrap repli-\n                        cates. If you specified other options in the original phylo_path call you don’t\n                        need to specify them again.\nValue\n    An object of class fitted_DAG.\nExamples\n       candidates <- define_model_set(\n         A = NL ~ BM,\n         B = NL ~ LS,\n         .common = c(LS ~ BM, DD ~ NL)\n       )\n       p <- phylo_path(candidates, rhino, rhino_tree)\n       best_model <- best(p)\n       # Print the best model to see coefficients, se and ci:\n       best_model\n       # Plot to show the weighted graph:\n       plot(best_model)\n  choice                       Extract and estimate an arbitrary model from a phylogenetic path\n                               analysis.\nDescription\n    Extract and estimate an arbitrary model from a phylogenetic path analysis.\nUsage\n    choice(phylopath, choice, ...)\nArguments\n    phylopath           An object of class phylopath.\n    choice              A character string of the name of the model to be chosen, or the index in\n                        model_set.\n    ...                 Arguments to pass to phylolm::phylolm and phylolm::phyloglm. Provide boot\n                        = K parameter to enable bootstrapping, where K is the number of bootstrap repli-\n                        cates. If you specified other options in the original phylo_path call you don’t\n                        need to specify them again.\nValue\n    An object of class fitted_DAG.\nExamples\n       candidates <- define_model_set(\n         A = NL ~ BM,\n         B = NL ~ LS,\n         .common = c(LS ~ BM, DD ~ NL)\n       )\n       p <- phylo_path(candidates, rhino, rhino_tree)\n       my_model <- choice(p, \"B\")\n       # Print the best model to see coefficients, se and ci:\n       my_model\n       # Plot to show the weighted graph:\n       plot(my_model)\n  cichlids                     Cichlid traits and the evolution of cooperative breeding.\nDescription\n    A data set with binary traits, used in an analysis on the evolution of cooperative breeding by Dey\n    et al 2017. Variable names are shortened for easy of use and consist of cooperative breeding (C),\n    mating system (M), parental care (P), social grouping (G) and diet (D). All traits are coded as two\n    level factors.\nUsage\n    cichlids\nFormat\n    An object of class data.frame with 69 rows and 5 columns.\nSource\n     ., ., ., ., . & . 2017. Direct\n     benefits and evolutionary transitions to complex societies. Nat Ecol Evol 1: 137.\n   cichlids_tree                 Cichlid phylogeny.\nDescription\n     The phylogenetic tree of cichlid species that accompanies the cichlids dataset. The phylogeny is\n     based on five nuclear genes and three mitochondrial genes.\nUsage\n     cichlids_tree\nFormat\n     An object of class phylo of length 4.\nSource\n     ., ., ., ., . & . 2017. Direct\n     benefits and evolutionary transitions to complex societies. Nat Ecol Evol 1: 137.\n   coef_plot                     Plot path coefficients and their confidence intervals or standard errors.\nDescription\n     Plot path coefficients and their confidence intervals or standard errors.\nUsage\n     coef_plot(\n       fitted_DAG,\n       error_bar = \"ci\",\n       order_by = \"default\",\n       from = NULL,\n       to = NULL,\n       reverse_order = FALSE\n     )\nArguments\n    fitted_DAG          A fitted DAG, usually obtained by best(), average() or est_DAG().\n    error_bar           Whether to use confidence intervals (\"ci\") or standard errors (\"se\") as error\n                        bars. Will force standard errors with a message if confidence intervals are not\n                        available.\n    order_by            By \"default\", the paths are ordered as in the the model that is supplied. Usually\n                        this is in the order that was established by [phylo_path()] for all combined\n                        graphs. This can be change to \"causal\" to do a reordering based on the model at\n                        hand, or to \"strength\" to order them by the standardized regression coefficient.\n    from                Only show path coefficients from these nodes. Supply as a character vector.\n    to                  Only show path coefficients to these nodes. Supply as a character vector.\n    reverse_order       If TRUE, the paths are plotted in reverse order. Particularly useful in combination\n                        with ggplot2::coord_flip() to create horizontal versions of the plot.\nValue\n    A ggplot object.\nExamples\n      d <- DAG(LS ~ BM, NL ~ BM, DD ~ NL + LS)\n      plot(d)\n      d_fitted <- est_DAG(d, rhino, rhino_tree, 'lambda')\n      plot(d_fitted)\n      coef_plot(d_fitted, error_bar = \"se\")\n      # to create a horizontal version, use this:\n      coef_plot(d_fitted, error_bar = \"se\", reverse_order = TRUE) + ggplot2::coord_flip()\n  DAG                           Directed acyclic graphs (DAGs)\nDescription\n    This function is a simple wrapper around the function from the ggm package with the same name.\n    The only differences are that the order argument defaults to TRUE and that it adds a DAG class for\n    easy plotting. Typically, one would use define_model_set() to create models for use with the\n    phylopath package.\nUsage\n    DAG(..., order = TRUE)\nArguments\n     ...                 a sequence of model formulae\n     order               logical, defaulting to TRUE. If TRUE the nodes of the DAG are permuted accord-\n                         ing to the topological order. If FALSE the nodes are in the order they first appear\n                         in the model formulae (from left to right). For use in the phylopath package,\n                         this should always be kept to TRUE, but the argument is available to avoid poten-\n                         tial problems with masking the function from other packages.\nDetails\n     Supply a formulas for the model as arguments. Formulas should be of the form child ~ parent`` and describe each path\n     ~ parent1 + parent2. Finally, an isolate (unconnected variable) can be included as being connected to itsel\n     late ~ isolate‘.\nValue\n     An object of classes matrix and DAG\nExamples\n        # Use formula notation to create DAGs:\n        plot(DAG(A~B, B~C))\n        # Use + to easily add multiple parents to a node:\n        plot(DAG(A~B+C))\n        # Add a node as it's own parent to create an isolate:\n        plot(DAG(A~B+C, D~D))\n  define_model_set               Define a model set.\nDescription\n     This is a convenience function to quickly and clearly define a set of causal models. Supply a list\n     of formulas for each model, using either c(). Formulas should be of the form child ~ parent and\n     describe each path in your model. Multiple children of a single parent can be combined into a single\n     formula: child ~ parent1 + parent2.\nUsage\n     define_model_set(..., .common = NULL)\nArguments\n     ...                 Named arguments, which each are a lists of formulas defining the paths of a\n                         causal model.\n     .common             A list of formulas that contain causal paths that are common to each model.\nDetails\n     This function uses ggm::DAG().\nValue\n     A list of models, each of class matrix and DAG.\nExamples\n     (m <- define_model_set(\n       A = c(a~b, b~c),\n       B = c(b~a, c~b),\n       .common = c(d~a)))\n     plot_model_set(m)\n   est_DAG                      Add standardized path coefficients to a DAG.\nDescription\n     Add standardized path coefficients to a DAG.\nUsage\n     est_DAG(DAG, data, tree, model, method, boot = 0, ...)\nArguments\n     DAG                 A directed acyclic graph, typically created with DAG.\n     data                A data.frame with data. If you have binary variables, make sure they are either\n                         character values or factors!\n     tree                A phylogenetic tree of class phylo.\n     model               The evolutionary model used for the regressions on continuous variables. See\n                         phylolm::phylolm for options and details. Defaults to Pagel’s lambda model\n     method              The estimation method for the binary models. See phylolm::phyloglm for op-\n                         tions and details. Defaults to logistic MPLE.\n     boot                The number of bootstrap replicates used to estimate confidence intervals.\n     ...                 Arguments passed on to phylolm:\n                         lower.bound: optional lower bound for the optimization of the phylogenetic\n                         model parameter.\n                         upper.bound: optional upper bound for the optimization of the phylogenetic\n                         model parameter.\n                         starting.value: optional starting value for the optimization of the phyloge-\n                         netic model parameter.\n                        measurement_error: a logical value indicating whether there is measurement\n                        error sigma2_error (see Details).\n                        Arguments passed on to phyloglm:\n                        btol: bound on the linear predictor to bound the searching space.\n                        log.alpha.bound: bound for the log of the parameter alpha.\n                        start.beta: starting values for beta coefficients.\n                        start.alpha: starting values for alpha (phylogenetic correlation).\nValue\n    An object of class fitted_DAG.\nExamples\n      d <- DAG(LS ~ BM, NL ~ BM, DD ~ NL + LS)\n      plot(d)\n      d_fitted <- est_DAG(d, rhino, rhino_tree, 'lambda')\n      plot(d_fitted)\n  phylo_path                    Compare causal models in a phylogenetic context.\nDescription\n    Continuous variables are modeled using phylolm::phylolm, while binary traits are modeled using\n    phylolm::phyloglm.\nUsage\n    phylo_path(\n      model_set,\n      data,\n      tree,\n      model = \"lambda\",\n      method = \"logistic_MPLE\",\n      order = NULL,\n      parallel = NULL,\n      na.rm = TRUE,\n      ...\n    )\nArguments\n    model_set           A list of directed acyclic graphs. These are matrices, typically created with\n                        define_model_set.\n    data                A data.frame with data. If you have binary variables, make sure they are either\n                        character values or factors!\n    tree                A phylogenetic tree of class phylo.\n    model               The evolutionary model used for the regressions on continuous variables. See\n                        phylolm::phylolm for options and details. Defaults to Pagel’s lambda model\n    method              The estimation method for the binary models. See phylolm::phyloglm for op-\n                        tions and details. Defaults to logistic MPLE.\n    order               Causal order of the included variable, given as a character vector. This is used to\n                        determine which variable should be the dependent in the dsep regression equa-\n                        tions. If left unspecified, the order will be automatically determined. If the\n                        combination of all included models is itself a DAG, then the ordering of that\n                        full model is used. Otherwise, the most common ordering between each pair of\n                        variables is used to create a general ordering.\n    parallel            Superseded From v1.2 phylopath uses the future package for all parallel pro-\n                        cessing, see details.\n    na.rm               Should rows that contain missing values be dropped from the data as necessary\n                        (with a message)?\n    ...                 Arguments passed on to phylolm:\n                        lower.bound: optional lower bound for the optimization of the phylogenetic\n                        model parameter.\n                        upper.bound: optional upper bound for the optimization of the phylogenetic\n                        model parameter.\n                        starting.value: optional starting value for the optimization of the phyloge-\n                        netic model parameter.\n                        measurement_error: a logical value indicating whether there is measurement\n                        error sigma2_error (see Details).\n                        Arguments passed on to phyloglm:\n                        btol: bound on the linear predictor to bound the searching space.\n                        log.alpha.bound: bound for the log of the parameter alpha.\n                        start.beta: starting values for beta coefficients.\n                        start.alpha: starting values for alpha (phylogenetic correlation).\nDetails\n    Parallel processing: From v1.2, phylopath uses the future framework for parallel processing.\n    This is compatible with the parallel computation within the underlying phylolm, making it easy to\n    enable parallel processing of multiple models, and of bootstrap replicates. To enable, simply set a\n    parallel plan() using the future package. Typically, you’ll want to run future::plan(\"multisession\",\n    workers = n), where n is the number of cores. Now parallel processing is enabled. Return to se-\n    quantial processing using future::plan(\"sequential\")\nValue\n    A phylopath object, with the following components:\n    d_sep for each model a table with separation statements and statistics.\n    model_set the DAGs\n    data the supplied data\n     tree the supplied tree\n     model the employed model of evolution in phylolm\n     method the employed method in phyloglm\n     dots any additional arguments given, these are passed on to downstream functions\n     warnings any warnings generated by the models\nExamples\n       #see vignette('intro_to_phylopath') for more details\n       candidates <- define_model_set(\n          A = NL ~ BM,\n          B = NL ~ LS,\n          .common = c(LS ~ BM, DD ~ NL)\n       )\n       p <- phylo_path(candidates, rhino, rhino_tree)\n       # Printing p gives some general information:\n       p\n       # And the summary gives statistics to compare the models:\n       summary(p)\n   plot.DAG                     Plot a directed acyclic graph.\nDescription\n     Plot a directed acyclic graph.\nUsage\n     ## S3 method for class 'DAG'\n     plot(\n        x,\n        labels = NULL,\n        algorithm = \"sugiyama\",\n        manual_layout = NULL,\n        text_size = 6,\n        box_x = 12,\n        box_y = 8,\n        edge_width = 1.5,\n        curvature = 0.02,\n        rotation = 0,\n        flip_x = FALSE,\n        flip_y = FALSE,\n        arrow = grid::arrow(type = \"closed\", 18, grid::unit(15, \"points\")),\n        ...\n     )\nArguments\n   x                A ‘DAG“ object, usually created with the define_model_set() or DAG() func-\n                    tion.\n   labels           An optional set of labels to use for the nodes. This should be a named vec-\n                    tor, of the form c(var1 = \"label1\", var2 = \"label2\"). If left at ‘NULL“, the\n                    variable names of the DAGs are used.\n   algorithm        A layout algorithm from igraph, see ggraph::create_layout(). By default,\n                    uses the Sugiyama layout algorithm, which is designed to minimize edge cross-\n                    ing in DAGs.\n   manual_layout    Alternatively, precisely define the layout yourself, by providing a data.frame\n                    that at least has a column name with all variable names, and columns x and y\n                    with positions to be plotted. Setting this parameter overrides algorithm but\n                    other changes, such as rotation and flips will still be applied.\n   text_size        Size of the node label text.\n   box_x            To avoid the arrows colliding with the nodes, specify the rectangular dimensions\n                    of an invisible box around each node. If you have long labels, you need to\n                    increase this.\n   box_y            To avoid the arrows colliding with the nodes, specify the rectangular dimensions\n                    of an invisible box around each node. If you have multi-line labels, you need to\n                    increase this.\n   edge_width       Width of the edges.\n   curvature        Curvature of the edges. A slight curvature can look pretty.\n   rotation         Supply the degrees you want to rotate the layout by. This is useful in order to\n                    put rotate your upstream nodes towards the top if needed.\n   flip_x           Whether to flip the node positions horizontally.\n   flip_y           Whether to flip the node positions vertically.\n   arrow            A grid::arrow object, specifying the shape and size of the arrowheads.\n                    The order of facets is taken from the ordering of the list, with the facet labels\n                    coming from the names of the list. If the list is unnamed, sequential lettering is\n                    used.\n   ...              Not used.\nExamples\n     d <- DAG(a ~ b + c + d)\n     plot(d)\n     # Plot with manually defined positions:\n     ml <- data.frame(\n       name = c('a', 'b', 'c', 'd'),\n       x = c(1, 1, 2, 2),\n       y = c(1, 2, 1, 2)\n     )\n     plot(d, manual_layout = ml)\n   plot.fitted_DAG                Plot a directed acyclic graph with path coefficients.\nDescription\n     Plot a directed acyclic graph with path coefficients.\nUsage\n     ## S3 method for class 'fitted_DAG'\n     plot(\n         x,\n         type = \"width\",\n         labels = NULL,\n         algorithm = \"sugiyama\",\n         manual_layout = NULL,\n         text_size = 6,\n         box_x = 12,\n         box_y = 8,\n         edge_width = 1.25,\n         curvature = 0.02,\n         rotation = 0,\n         flip_x = FALSE,\n         flip_y = FALSE,\n         arrow = grid::arrow(type = \"closed\", 18, grid::unit(15, \"points\")),\n         colors = c(\"firebrick\", \"navy\"),\n         show.legend = TRUE,\n         width_const = NULL,\n         ...\n     )\nArguments\n     x                   An object of class fitted_DAG.\n     type                How to express the weight of the path. Either \"width\", or \"color\".\n     labels              An optional set of labels to use for the nodes. This should be a named vec-\n                         tor, of the form c(var1 = \"label1\", var2 = \"label2\"). If left at ‘NULL“, the\n                         variable names of the DAGs are used.\n     algorithm           A layout algorithm from igraph, see ggraph::create_layout(). By default,\n                         uses the Sugiyama layout algorithm, which is designed to minimize edge cross-\n                         ing in DAGs.\n     manual_layout       Alternatively, precisely define the layout yourself, by providing a data.frame\n                         that at least has a column name with all variable names, and columns x and y\n                         with positions to be plotted. Setting this parameter overrides algorithm but\n                         other changes, such as rotation and flips will still be applied.\n     text_size           Size of the node label text.\n     box_x               To avoid the arrows colliding with the nodes, specify the rectangular dimensions\n                         of an invisible box around each node. If you have long labels, you need to\n                         increase this.\n     box_y               To avoid the arrows colliding with the nodes, specify the rectangular dimensions\n                         of an invisible box around each node. If you have multi-line labels, you need to\n                         increase this.\n     edge_width          Width of the edges.\n     curvature           Curvature of the edges. A slight curvature can look pretty.\n     rotation            Supply the degrees you want to rotate the layout by. This is useful in order to\n                         put rotate your upstream nodes towards the top if needed.\n     flip_x              Whether to flip the node positions horizontally.\n     flip_y              Whether to flip the node positions vertically.\n     arrow               A grid::arrow object, specifying the shape and size of the arrowheads.\n                         The order of facets is taken from the ordering of the list, with the facet labels\n                         coming from the names of the list. If the list is unnamed, sequential lettering is\n                         used.\n     colors              The end points of the continuous color scale. Keep in mind that red and green\n                         are obvious colors to use, but are better to be avoided because of color blind\n                         users.\n     show.legend         Whether a legend for the color scale should be shown.\n     width_const         Deprecated.\n     ...                 Not used.\nExamples\n       d <- DAG(LS ~ BM, NL ~ BM, DD ~ NL + LS)\n       d_fitted <- est_DAG(d, rhino, rhino_tree, 'lambda')\n       plot(d_fitted)\n   plot_model_set                Plot several causal hypothesis at once.\nDescription\n     Plot several causal hypothesis at once.\nUsage\n     plot_model_set(\n       model_set,\n       labels = NULL,\n       algorithm = \"kk\",\n       manual_layout = NULL,\n       text_size = 5,\n       box_x = 12,\n       box_y = 10,\n       edge_width = 1,\n       curvature = 0.05,\n       rotation = 0,\n       flip_x = FALSE,\n       flip_y = FALSE,\n       nrow = NULL,\n       arrow = grid::arrow(type = \"closed\", 15, grid::unit(10, \"points\"))\n     )\nArguments\n     model_set       A list of DAG objects, usually created with define_model_set().\n     labels          An optional set of labels to use for the nodes. This should be a named vec-\n                     tor, of the form c(var1 = \"label1\", var2 = \"label2\"). If left at ‘NULL“, the\n                     variable names of the DAGs are used.\n     algorithm       A layout algorithm from igraph, see ggraph::create_layout(). By default,\n                     uses the Kamada-Kawai layout algorithm. Another good option is \"sugiyama\",\n                     which is designed to minimize edge crossing in DAGs. However, it can often\n                     plot nodes too close together.\n     manual_layout   Alternatively, precisely define the layout yourself, by providing a data.frame\n                     that at least has a column name with all variable names, and columns x and y\n                     with positions to be plotted. Setting this parameter overrides algorithm but\n                     other changes, such as rotation and flips will still be applied.\n     text_size       Size of the node label text.\n     box_x           To avoid the arrows colliding with the nodes, specify the rectangular dimensions\n                     of an invisible box around each node. If you have long labels, you need to\n                     increase this.\n     box_y           To avoid the arrows colliding with the nodes, specify the rectangular dimensions\n                     of an invisible box around each node. If you have multi-line labels, you need to\n                     increase this.\n     edge_width      Width of the edges.\n     curvature       Curvature of the edges. A slight curvature can look pretty.\n     rotation        Supply the degrees you want to rotate the layout by. This is useful in order to\n                     put rotate your upstream nodes towards the top if needed.\n     flip_x          Whether to flip the node positions horizontally.\n     flip_y          Whether to flip the node positions vertically.\n     nrow                 Number of rows to display the models on.\n     arrow                A grid::arrow object, specifying the shape and size of the arrowheads.\n                          The order of facets is taken from the ordering of the list, with the facet labels\n                          coming from the names of the list. If the list is unnamed, sequential lettering is\n                          used.\nValue\n     A ggplot object.\nExamples\n     m <- list(one = DAG(a ~ b + c + d), two = DAG(a ~ b, b ~ c, d ~ d))\n     plot_model_set(m)\n     plot_model_set(m, algorithm = \"sugiyama\")\n   red_list                     Data on brain size, life history and vulnerability to extinction\nDescription\n     A dataset with continuous variables affecting the conservation Status of mammalian species (the\n     IUCN red list of threatened species).\nUsage\n     red_list\nFormat\n     An object of class data.frame with 474 rows and 7 columns.\nDetails\n     It includes the following variables: brain size (Br), body size (B), gestation period (G), litter size (L),\n     weening age (W), population density (P) and vulnerability to extinction (Status).\nSource\n     , , , Revilla E (2016) Larger brain size indirectly in-\n     creases vulnerability to extinction in mammals. Evolution 70:1364-1375. doi: 10.1111/evo.12943\n   red_list_tree                 Mammalian phylogeny\nDescription\n     This is the accompanying phylogeny for the red_list data set. It is based on the updated mammalian\n     supertree by Bininda-Emonds et al. 2007 & Fritz et al. 2009.\nUsage\n     red_list_tree\nFormat\n     An object of class phylo of length 4.\nSource\n     Gonzalez-Voyer, . . and . 2016. Larger brain size indirectly\n     increases vulnerability to extinction in mammals. Evolution 70:1364-1375. doi: 10.1111/evo.12943.\n     Bininda-Emonds, ., , , , , ,\n     , , , and . 2007. The delayed rise of present-day\n     mammals. Nature 446:507-512.\n     ., . Bininda-Emonds, and . 2009. Geographical variation in predictors of\n     mammalian extinction risk: big is bad, but only in the tropics. Ecol. Lett. 12:538-549.\n   rhino                         Rhinogrades traits.\nDescription\n     A simulated dataset, as used by Gonzalez-Voyer and  as an example, containing\n     variables on body mass (BM), litter size (LS), nose length (NL), dispersal distance (DD) and range\n     size (RS).\nUsage\n     rhino\nFormat\n     An object of class data.frame with 100 rows and 6 columns.\nSource\n      & . 2014. An Introduction to Phylogenetic Path Analysis.\n     Chapter 8. In: Garamszegi LZ (ed.), Modern Phylogenetic Comparative Methods and Their Appli-\n     cation in Evolutionary Biology. pp. 201-229. Springer-Verlag Berlin Heidelberg. doi:10.1111/j.1558-\n     5646.2012.01790.x\n   rhino_tree                   Rhinogrades phylogeny.\nDescription\n     A phylogenetic tree for the 100 species of the rhino dataset.\nUsage\n     rhino_tree\nFormat\n     An object of class phylo of length 4.\nSource\n      & . 2014. An Introduction to Phylogenetic Path Analysis.\n     Chapter 8. In: Garamszegi LZ (ed.), Modern Phylogenetic Comparative Methods and Their Appli-\n     cation in Evolutionary Biology. pp. 201-229. Springer-Verlag Berlin Heidelberg. doi:10.1111/j.1558-\n     5646.2012.01790.x\n   show_warnings                Print out warnings from a phylopath analysis.\nDescription\n     Use this function after running phylo_path() to conveniently print any generated warnings to the\n     screen. You can either provide no arguments, which will only work if you run it directly after the\n     analysis, or you have to provide the phylopath object manually.\nUsage\n     show_warnings(phylopath = NULL)\nArguments\n     phylopath           A phylopath object of which the warnings should be printed."}}},{"rowIdx":452,"cells":{"project":{"kind":"string","value":"r_enum"},"source":{"kind":"string","value":"hex"},"language":{"kind":"string","value":"Erlang"},"content":{"kind":"string","value":"README\n===\n\n[![hex.pm version](https://img.shields.io/hexpm/v/r_enum.svg)](https://hex.pm/packages/r_enum)\n[![CI](https://github.com/tashirosota/ex-r_enum/actions/workflows/ci.yml/badge.svg)](https://github.com/tashirosota/ex-r_enum/actions/workflows/ci.yml)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/tashirosota/ex-r_enum)\n\nREnum\n===\n\nREnum is Enum extended with convenient functions inspired by Ruby and Rails ActiveSupport.\nIt also provides full support for native functions through metaprogramming.\nIn addition to REnum, modules such as RList, RMap, RRange can also be used.\n\n* [REnum](#renum)\n\t+ [Installation](#installation)\n\t+ [About REnum](#about-renum)\n\t\t- [compact/1](#compact-1)\n\t\t- [each_slice/2](#each_slice-2)\n\t\t- [grep/2](#grep-2)\n\t\t- [reverse_each/2](#reverse_each-2)\n\t\t- [pluck/2](#pluck-2)\n\t\t- [exclude?/2](#exclude-2)\n\t\t- [without/2](#without-2)\n\t\t- [many?/2](#many-2)\n\t\t- [list_and_not_keyword?/1](#list_and_not_keyword-1)\n\t\t- [map_and_not_range?/1](#map_and_not_range-1)\n\t+ [About RList](#about-rlist)\n\t\t- [push/2](#push-2)\n\t\t- [combination/2](#combination-2)\n\t\t- [fill/3](#fill-3)\n\t\t- [dig/3](#dig-3)\n\t\t- [intersection/2](#intersection-2)\n\t\t- [sample/2](#sample-2)\n\t\t- [values_at/1](#values_at-1)\n\t\t- [second/1](#second-1)\n\t\t- [from/2](#from-2)\n\t\t- [to_sentence/2](#to_sentence-2)\n\t\t- [new/2](#new-2)\n\t+ [About RMap](#about-rmap)\n\t\t- [dig/2](#dig-2)\n\t\t- [each_key/2](#each_key-2)\n\t\t- [except/2](#except-2)\n\t\t- [invert/1](#invert-1)\n\t\t- [values_at/2](#values_at-2)\n\t\t- [deep_atomize_keys/1](#deep_atomize_keys-1)\n\t\t- [deep_transform_keys/2](#deep_transform_keys-2)\n\t+ [About RRange](#about-rrange)\n\t\t- [begin/1](#begin-1)\n\t\t- [step/2](#step-2)\n\t\t- [overlaps?/2](#overlaps-2)\n\t+ [About RUtils](#about-rutils)\n\t\t- [blank?/1](#blank-1)\n\t\t- [present?/1](#present-1)\n\t\t- [define_all_functions!/2](#define_all_functions-2)\n\t+ [Progress](#progress)\n\n Installation\n---\n```\ndef deps do\n [\n {:r_enum, \"~> 0.6\"}\n ]\nend\n```\nFor the full list of available functions, see [API Reference](https://hexdocs.pm/r_enum/api-reference.html).\n\n About [REnum](https://hexdocs.pm/r_enum/REnum.html)\n---\n\n**All the functions are available defined in**\n\n* [Enum](https://hexdocs.pm/r_enum/REnum.Native.html)\n* [REnum.Ruby](https://hexdocs.pm/r_enum/REnum.Ruby.html)\n* [REnum.ActiveSupport](https://hexdocs.pm/r_enum/REnum.ActiveSupport.html)\n* [REnum.Support](https://hexdocs.pm/r_enum/REnum.Support.html)\n\n### \n\n compact/1\n\nReturns an list of all non-nil elements.\n```\niex> REnum.compact([1, nil, 2, 3])\n[1, 2, 3]\n# See also REnum.ActiveSupport.compact_blank\n```\n### \n\n each_slice/2\n\nReturns Stream given enumerable sliced by each amount.\n```\niex> [\"a\", \"b\", \"c\", \"d\", \"e\"]\niex> |> REnum.each_slice(2)\niex> |> Enum.to_list()\n[[\"a\", \"b\"], [\"c\", \"d\"], [\"e\"]]\n```\n### \n\n grep/2\n\nReturns elements selected by a given pattern or function.\n```\niex> [\"foo\", \"bar\", \"car\", \"moo\"]\niex> |> REnum.grep(~r/ar/)\n[\"bar\", \"car\"]\n\niex> 1..10 iex> |> REnum.grep(3..8)\n[3, 4, 5, 6, 7, 8]\n```\n### \n\n reverse_each/2\n\nCalls the function with each element, but in reverse order; returns given enumerable.\n```\niex> REnum.reverse_each([1, 2, 3], &IO.inspect(&1))\n# 3\n# 2\n# 1\n[1, 2, 3]\n```\n### \n\n pluck/2\n\nExtract the given key from each element in the enumerable.\n```\niex> payments = [\n...>  %Payment{dollars: 5, cents: 99},\n...>  %Payment{dollars: 10, cents: 0},\n...>  %Payment{dollars: 0, cents: 5}\n...> ]\niex> REnum.pluck(payments, [:dollars, :cents])\n[[5, 99], [10, 0], [0, 5]]\niex> REnum.pluck(payments, :dollars)\n[5, 10, 0]\niex> REnum.pluck([], :dollars)\n[]\n```\n### \n\n exclude?/2\n\nThe negative of the `Enum.member?`.Returns true+if the collection does not include the object.\n```\niex> REnum.exclude?([2], 1)\ntrue\n\niex> REnum.exclude?([2], 2)\nfalse\n# See also REnum.ActiveSupport.include?\n```\n### \n\n without/2\n\nReturns enumerable excluded the specified elements.\n```\niex> REnum.without(1..5, [1, 5])\n[2, 3, 4]\n\niex> REnum.without(%{foo: 1, bar: 2, baz: 3}, [:bar])\n%{foo: 1, baz: 3}\n# See also REnum.ActiveSupport.including\n```\n### \n\n many?/2\n\nReturns true if the enumerable has more than 1 element.\n```\niex>  REnum.many?([])\nfalse\n\niex> REnum.many?([1])\nfalse\n\niex> REnum.many?([1, 2])\ntrue\n\niex> REnum.many?(%{})\nfalse\n\niex> REnum.many?(%{a: 1})\nfalse\n\niex> REnum.many?(%{a: 1, b: 2})\ntrue\n```\n### \n\n list_and_not_keyword?/1\n\nReturns true if argument is list and not keyword list.\n```\niex> REnum.list_and_not_keyword?([1, 2, 3])\ntrue\n\niex> REnum.list_and_not_keyword?([a: 1, b: 2])\nfalse\n```\n### \n\n map_and_not_range?/1\n\nReturns true if argument is map and not range.\n```\niex> REnum.map_and_not_range?(%{})\ntrue\n\niex> REnum.map_and_not_range?(1..3)\nfalse\n```\n About [RList](https://hexdocs.pm/r_enum/RList.html)\n---\n\nRList is List extended with convenient functions inspired by Ruby and Rails ActiveSupport.\n**All the functions are available defined in**\n\n* [List](https://hexdocs.pm/r_enum/RList.Native.html)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html)\n* [RList.Ruby](https://hexdocs.pm/r_enum/RList.Ruby.html)\n* [RList.ActiveSupport](https://hexdocs.pm/r_enum/RList.ActiveSupport.html)\n* [RList.Support](https://hexdocs.pm/r_enum/RList.Support.html)\n\n### \n\n push/2\n\nAppends trailing elements.\n```\niex> [:foo, 'bar', 2]\niex> |> RList.push([:baz, :bat])\n[:foo, 'bar', 2, :baz, :bat]\n\niex> [:foo, 'bar', 2]\niex> |> RList.push(:baz)\n[:foo, 'bar', 2, :baz]\n# See also REnum.Ruby.shift, REnum.Ruby.pop, REnum.Ruby.unshift\n```\n### \n\n combination/2\n\nReturns Stream that is each repeated combinations of elements of given list. The order of combinations is indeterminate.\n```\niex> RList.combination([1, 2, 3, 4], 1)\niex> |> Enum.to_list()\n[[1],[2],[3],[4]]\n\niex> RList.combination([1, 2, 3, 4], 3)\niex> |> Enum.to_list()\n[[1,2,3],[1,2,4],[1,3,4],[2,3,4]]\n\niex> RList.combination([1, 2, 3, 4], 0)\niex> |> Enum.to_list()\n[[]]\n\niex> RList.combination([1, 2, 3, 4], 5)\niex> |> Enum.to_list()\n[]\n# See also RList.Ruby.repeated_combination, RList.Ruby.permutation, RList.Ruby.repeated_permutation\n```\n### \n\n fill/3\n\nFills the list with the provided value. The filler can be either a function or a fixed value.\n```\niex> RList.fill(~w[a b c d], \"x\")\n[\"x\", \"x\", \"x\", \"x\"]\n\niex> RList.fill(~w[a b c d], \"x\", 0..1)\n[\"x\", \"x\", \"c\", \"d\"]\n\niex> RList.fill(~w[a b c d], fn _, i -> i * i end)\n[0, 1, 4, 9]\n\niex> RList.fill(~w[a b c d], fn _, i -> i * 2 end, 0..1)\n[0, 2, \"c\", \"d\"]\n```\n### \n\n dig/3\n\nFinds and returns the element in nested elements that is specified by index and identifiers.\n```\niex> [:foo, [:bar, :baz, [:bat, :bam]]]\niex> |> RList.dig(1)\n[:bar, :baz, [:bat, :bam]]\n\niex> [:foo, [:bar, :baz, [:bat, :bam]]]\niex> |> RList.dig(1, [2])\n[:bat, :bam]\n\niex> [:foo, [:bar, :baz, [:bat, :bam]]]\niex> |> RList.dig(1, [2, 0])\n:bat\n\niex> [:foo, [:bar, :baz, [:bat, :bam]]]\niex> |> RList.dig(1, [2, 3])\nnil\n```\n### \n\n intersection/2\n\nReturns a new list containing each element found both in list1 and in all of the given list2; duplicates are omitted.\n```\niex> [1, 2, 3]\niex> |> RList.intersection([3, 4, 5])\n[3]\n\niex> [1, 2, 3]\niex> |> RList.intersection([5, 6, 7])\n[]\n\niex> [1, 2, 3]\niex> |> RList.intersection([1, 2, 3])\n[1, 2, 3]\n\"\"\"\n```\n### \n\n sample/2\n\nReturns one or more random elements.\n\n### \n\n values_at/1\n\nReturns a list containing the elements in list corresponding to the given selector(s).The selectors may be either integer indices or ranges.\n```\niex> RList.values_at(~w[a b c d e f], [1, 3, 5])\n[\"b\", \"d\", \"f\"]\n\niex> RList.values_at(~w[a b c d e f], [1, 3, 5, 7])\n[\"b\", \"d\", \"f\", nil]\n\niex> RList.values_at(~w[a b c d e f], [-1, -2, -2, -7])\n[\"f\", \"e\", \"e\", nil]\n\niex> RList.values_at(~w[a b c d e f], [4..6, 3..5])\n[\"e\", \"f\", nil, \"d\", \"e\", \"f\"]\n\niex> RList.values_at(~w[a b c d e f], 4..6)\n[\"e\", \"f\", nil]\n```\n### \n\n second/1\n\nEqual to `Enum.at(list, 1)`.\n```\niex> ~w[a b c d]\niex> |> RList.second()\n\"b\"\n# See also RList.ActiveSupport.third, RList.ActiveSupport.fourth, RList.ActiveSupport.fifth and RList.ActiveSupport.forty_two\n```\n### \n\n from/2\n\nReturns the tail of the list from position.\n```\niex> ~w[a b c d]\niex> |> RList.from(0)\n[\"a\", \"b\", \"c\", \"d\"]\n\niex> ~w[a b c d]\niex> |> RList.from(2)\n[\"c\", \"d\"]\n\niex> ~w[a b c d]\niex> |> RList.from(10)\n[]\n\niex> ~w[]\niex> |> RList.from(0)\n[]\n\niex> ~w[a b c d]\niex> |> RList.from(-2)\n[\"c\", \"d\"]\n\niex> ~w[a b c d]\niex> |> RList.from(-10)\n[]\n# See also RList.ActiveSupport.to\n```\n### \n\n to_sentence/2\n\nConverts the list to a comma-separated sentence where the last element is joined by the connector word.\n\nYou can pass the following options to change the default behavior. If you pass an option key that doesn't exist in the list below, it will raise an\n\n**Options**\n\n* `:words_connector` - The sign or word used to join all but the last element in lists with three or more elements (default: \", \").\n* `:last_word_connector` - The sign or word used to join the last element in lists with three or more elements (default: \", and \").\n* `:two_words_connector` - The sign or word used to join the elements in lists with two elements (default: \" and \").\n```\niex> [\"one\", \"two\"]\niex> |> RList.to_sentence()\n\"one and two\"\n\niex> [\"one\", \"two\", \"three\"]\niex> |> RList.to_sentence()\n\"one, two, and three\"\n\niex> [\"one\", \"two\"]\niex> |> RList.to_sentence(two_words_connector: \"-\")\n\"one-two\"\n\niex> [\"one\", \"two\", \"three\"]\niex> |> RList.to_sentence(words_connector: \" or \", last_word_connector: \" or at least \")\n\"one or two or at least three\"\n\niex> [\"one\", \"two\", \"three\"]\niex> |> RList.to_sentence()\n\"one, two, and three\"\n```\n### \n\n new/2\n\nMake a list of size amount.\n```\niex> 1 iex> |> RList.new(3)\n[1, 1, 1]\n```\n About [RMap](https://hexdocs.pm/r_enum/RMap.html)\n---\n\nRMap is Map extended with convenient functions inspired by Ruby and Rails ActiveSupport.\n**All the functions are available defined in**\n\n* [Map](https://hexdocs.pm/r_enum/RMap.Native.html)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html)\n* [RMap.Ruby](https://hexdocs.pm/r_enum/RMap.Ruby.html)\n* [RMap.ActiveSupport](https://hexdocs.pm/r_enum/RMap.ActiveSupport.html)\n* [RMap.Support](https://hexdocs.pm/r_enum/RMap.Support.html)\n\n### \n\n dig/2\n\nReturns the object in nested map that is specified by a given key and additional arguments.\n```\niex> RMap.dig(%{a: %{b: %{c: 1}}}, [:a, :b, :c])\n1\n\niex> RMap.dig(%{a: %{b: %{c: 1}}}, [:a, :c, :b])\nnil\n```\n### \n\n each_key/2\n\nCalls the function with each key; returns :ok.\n```\niex> RMap.each_key(%{a: 1, b: 2, c: 3}, &IO.inspect(&1))\n# :a\n# :b\n# :c\n:ok\n# See also RMap.Ruby.each_value, RMap.Ruby.each_pair\n```\n### \n\n except/2\n\nReturns a map excluding entries for the given keys.\n```\niex> RMap.except(%{a: 1, b: 2, c: 3}, [:a, :b])\n%{c: 3}\n```\n### \n\n invert/1\n\nReturns a map object with the each key-value pair inverted.\n```\niex> RMap.invert(%{\"a\" => 0, \"b\" => 100, \"c\" => 200, \"d\" => 300, \"e\" => 300})\n%{0 => \"a\", 100 => \"b\", 200 => \"c\", 300 => \"e\"}\n\niex> RMap.invert(%{a: 1, b: 1, c: %{d: 2}})\n%{1 => :b, %{d: 2} => :c}\n```\n### \n\n values_at/2\n\nReturns a list containing values for the given keys.\n```\niex> RMap.values_at(%{a: 1, b: 2, c: 3}, [:a, :b, :d])\n[1, 2, nil]\n```\n### \n\n deep_atomize_keys/1\n\nReturns a list with all keys converted to atom.\nThis includes the keys from the root map and from all nested maps and arrays.\n```\niex> RMap.deep_atomize_keys(%{\"name\" => \"Rob\", \"years\" => \"28\", \"nested\" => %{ \"a\" => 1 }})\n%{name: \"Rob\", nested: %{a: 1}, years: \"28\"}\n\niex> RMap.deep_atomize_keys(%{\"a\" => %{\"b\" => %{\"c\" => 1}, \"d\" => [%{\"a\" => 1, \"b\" => %{\"c\" => 2}}]}})\n%{a: %{b: %{c: 1}, d: [%{a: 1, b: %{c: 2}}]}}\n# See also RList.ActiveSupport.deep_symbolize_keys, RList.ActiveSupport.symbolize_keys, RList.ActiveSupport.deep_stringify_keys, RList.ActiveSupport.stringify_keys,\n```\n### \n\n deep_transform_keys/2\n\nReturns a list with all keys converted to atom.\nThis includes the keys from the root map and from all nested maps and arrays.\n```\niex> RMap.deep_transform_keys(%{a: %{b: %{c: 1}}}, &to_string(&1))\n%{\"a\" => %{\"b\" => %{\"c\" => 1}}}\n\niex> RMap.deep_transform_keys(%{a: %{b: %{c: 1}, d: [%{a: 1, b: %{c: 2}}]}}, &inspect(&1))\n%{\":a\" => %{\":b\" => %{\":c\" => 1}, \":d\" => [%{\":a\" => 1, \":b\" => %{\":c\" => 2}}]}}\n# See also RList.ActiveSupport.deep_transform_values\n```\n About [RRange](https://hexdocs.pm/r_enum/RRange.html)\n---\n\n**All the functions are available defined in**\n\n* [Range](https://hexdocs.pm/r_enum/RRange.Native.html)\n* [RRange.Ruby](https://hexdocs.pm/r_enum/RRange.Ruby.html)\n* [RRange.ActiveSupport](https://hexdocs.pm/r_enum/RRange.ActiveSupport.html)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html)\n\n### \n\n begin/1\n\nReturns the first element of range.\n```\niex> RList.begin(1..3)\n1\n# See also RRange.Ruby.end\n```\n### \n\n step/2\n\nReturns Stream that from given range split into by given step.\n```\niex> RList.step(1..10, 2)\niex> |> Enum.to_list()\n[1, 3, 5, 7, 9]\n\"\"\"\n```\n### \n\n overlaps?/2\n\nCompare two ranges and see if they overlap each other.\n```\niex> RList.overlaps?(1..5, 4..6)\ntrue\n\niex> RList.overlaps?(1..5, 7..9)\nfalse\n```\n About [RUtils](https://hexdocs.pm/r_enum/RUtils.html)\n---\n\nSome useful functions.\n\n### \n\n blank?/1\n\nReturn true if object is blank, false, empty, or a whitespace string.\nFor example, +nil+, '', ' ', [], {}, and +false+ are all blank.\n```\niex>  RUtils.blank?(%{})\ntrue\n\niex> RUtils.blank?([1])\nfalse\n\niex> RUtils.blank?(\" \")\ntrue\n```\n### \n\n present?/1\n\nReturns true if not `RUtils.blank?`\n```\niex> RUtils.present?(%{})\nfalse\n\niex> RUtils.present?([1])\ntrue\n\niex> RUtils.present?(\" \")\nfalse\n```\n### \n\n define_all_functions!/2\n\nDefines in the module that called all the functions of the argument module.\n```\niex> defmodule A do\n...>  defmacro __using__(_opts) do\n...>  RUtils.define_all_functions!(__MODULE__)\n...>  end\n...>\n...>  def test do\n...>  :test\n...>  end\n...> end iex> defmodule B do\n...>  use A\n...> end iex> B.test\n:test\n```\n Progress\n---\n\n| REnum | Elixir Module | Ruby Class | Elixir | Ruby | ActiveSupport |\n| --- | --- | --- | --- | --- | --- |\n| REnum | Enum | Enumerable | ✅ | ✅ | ✅ |\n| RList | List | Array | ✅ | ✅ | ✅ |\n| RMap | Map | Hash | ✅ | ✅ | ✅ |\n| RRange | Range | Range | ✅ | ✅ | ✅ |\n| RStream | Stream | Enumerator::Lazy | ✅ | TODO | TODO |\n\n[API Reference](api-reference.html)\n\nMapKeyError exception\n===\n\nREnum\n===\n\nEntry point of Enum extensions, and can use all of REnum.* functions.\nSee also\n\n* [REnum.Native](https://hexdocs.pm/r_enum/REnum.Native.html#content)\n* [REnum.Ruby](https://hexdocs.pm/r_enum/REnum.Ruby.html#content)\n* [REnum.ActiveSupport](https://hexdocs.pm/r_enum/REnum.ActiveSupport.html#content)\n* [REnum.Support](https://hexdocs.pm/r_enum/REnum.Support.html#content)\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[all?(arg1)](#all?/1)\n\nSee [`Enum.all?/1`](https://hexdocs.pm/elixir/Enum.html#all?/1).\n\n[all?(arg1, arg2)](#all?/2)\n\nSee [`Enum.all?/2`](https://hexdocs.pm/elixir/Enum.html#all?/2).\n\n[any?(arg1)](#any?/1)\n\nSee [`Enum.any?/1`](https://hexdocs.pm/elixir/Enum.html#any?/1).\n\n[any?(arg1, arg2)](#any?/2)\n\nSee [`Enum.any?/2`](https://hexdocs.pm/elixir/Enum.html#any?/2).\n\n[at(arg1, arg2)](#at/2)\n\nSee [`Enum.at/2`](https://hexdocs.pm/elixir/Enum.html#at/2).\n\n[at(arg1, arg2, arg3)](#at/3)\n\nSee [`Enum.at/3`](https://hexdocs.pm/elixir/Enum.html#at/3).\n\n[chain(arg1)](#chain/1)\n\nSee [`REnum.Ruby.chain/1`](REnum.Ruby.html#chain/1).\n\n[chain(arg1, arg2)](#chain/2)\n\nSee [`REnum.Ruby.chain/2`](REnum.Ruby.html#chain/2).\n\n[chunk_by(arg1, arg2)](#chunk_by/2)\n\nSee [`Enum.chunk_by/2`](https://hexdocs.pm/elixir/Enum.html#chunk_by/2).\n\n[chunk_every(arg1, arg2)](#chunk_every/2)\n\nSee [`Enum.chunk_every/2`](https://hexdocs.pm/elixir/Enum.html#chunk_every/2).\n\n[chunk_every(arg1, arg2, arg3)](#chunk_every/3)\n\nSee [`Enum.chunk_every/3`](https://hexdocs.pm/elixir/Enum.html#chunk_every/3).\n\n[chunk_every(arg1, arg2, arg3, arg4)](#chunk_every/4)\n\nSee [`Enum.chunk_every/4`](https://hexdocs.pm/elixir/Enum.html#chunk_every/4).\n\n[chunk_while(arg1, arg2, arg3, arg4)](#chunk_while/4)\n\nSee [`Enum.chunk_while/4`](https://hexdocs.pm/elixir/Enum.html#chunk_while/4).\n\n[collect(arg1, arg2)](#collect/2)\n\nSee [`REnum.Ruby.collect/2`](REnum.Ruby.html#collect/2).\n\n[collect_concat(arg1, arg2)](#collect_concat/2)\n\nSee [`REnum.Ruby.collect_concat/2`](REnum.Ruby.html#collect_concat/2).\n\n[compact(arg1)](#compact/1)\n\nSee [`REnum.Ruby.compact/1`](REnum.Ruby.html#compact/1).\n\n[compact_blank(arg1)](#compact_blank/1)\n\nSee [`REnum.ActiveSupport.compact_blank/1`](REnum.ActiveSupport.html#compact_blank/1).\n\n[concat(arg1)](#concat/1)\n\nSee [`Enum.concat/1`](https://hexdocs.pm/elixir/Enum.html#concat/1).\n\n[concat(arg1, arg2)](#concat/2)\n\nSee [`Enum.concat/2`](https://hexdocs.pm/elixir/Enum.html#concat/2).\n\n[count(arg1)](#count/1)\n\nSee [`Enum.count/1`](https://hexdocs.pm/elixir/Enum.html#count/1).\n\n[count(arg1, arg2)](#count/2)\n\nSee [`Enum.count/2`](https://hexdocs.pm/elixir/Enum.html#count/2).\n\n[count_until(arg1, arg2)](#count_until/2)\n\nSee [`Enum.count_until/2`](https://hexdocs.pm/elixir/Enum.html#count_until/2).\n\n[count_until(arg1, arg2, arg3)](#count_until/3)\n\nSee [`Enum.count_until/3`](https://hexdocs.pm/elixir/Enum.html#count_until/3).\n\n[cycle(arg1, arg2, arg3)](#cycle/3)\n\nSee [`REnum.Ruby.cycle/3`](REnum.Ruby.html#cycle/3).\n\n[dedup(arg1)](#dedup/1)\n\nSee [`Enum.dedup/1`](https://hexdocs.pm/elixir/Enum.html#dedup/1).\n\n[dedup_by(arg1, arg2)](#dedup_by/2)\n\nSee [`Enum.dedup_by/2`](https://hexdocs.pm/elixir/Enum.html#dedup_by/2).\n\n[detect(arg1, arg2)](#detect/2)\n\nSee [`REnum.Ruby.detect/2`](REnum.Ruby.html#detect/2).\n\n[detect(arg1, arg2, arg3)](#detect/3)\n\nSee [`REnum.Ruby.detect/3`](REnum.Ruby.html#detect/3).\n\n[drop(arg1, arg2)](#drop/2)\n\nSee [`Enum.drop/2`](https://hexdocs.pm/elixir/Enum.html#drop/2).\n\n[drop_every(arg1, arg2)](#drop_every/2)\n\nSee [`Enum.drop_every/2`](https://hexdocs.pm/elixir/Enum.html#drop_every/2).\n\n[drop_while(arg1, arg2)](#drop_while/2)\n\nSee [`Enum.drop_while/2`](https://hexdocs.pm/elixir/Enum.html#drop_while/2).\n\n[each(arg1, arg2)](#each/2)\n\nSee [`Enum.each/2`](https://hexdocs.pm/elixir/Enum.html#each/2).\n\n[each_cons(arg1, arg2, arg3)](#each_cons/3)\n\nSee [`REnum.Ruby.each_cons/3`](REnum.Ruby.html#each_cons/3).\n\n[each_entry(arg1, arg2)](#each_entry/2)\n\nSee [`REnum.Ruby.each_entry/2`](REnum.Ruby.html#each_entry/2).\n\n[each_slice(arg1, arg2)](#each_slice/2)\n\nSee [`REnum.Ruby.each_slice/2`](REnum.Ruby.html#each_slice/2).\n\n[each_slice(arg1, arg2, arg3)](#each_slice/3)\n\nSee [`REnum.Ruby.each_slice/3`](REnum.Ruby.html#each_slice/3).\n\n[each_with_index(arg1)](#each_with_index/1)\n\nSee [`REnum.Ruby.each_with_index/1`](REnum.Ruby.html#each_with_index/1).\n\n[each_with_index(arg1, arg2)](#each_with_index/2)\n\nSee [`REnum.Ruby.each_with_index/2`](REnum.Ruby.html#each_with_index/2).\n\n[each_with_object(arg1, arg2, arg3)](#each_with_object/3)\n\nSee [`REnum.Ruby.each_with_object/3`](REnum.Ruby.html#each_with_object/3).\n\n[empty?(arg1)](#empty?/1)\n\nSee [`Enum.empty?/1`](https://hexdocs.pm/elixir/Enum.html#empty?/1).\n\n[entries(arg1)](#entries/1)\n\nSee [`REnum.Ruby.entries/1`](REnum.Ruby.html#entries/1).\n\n[exclude?(arg1, arg2)](#exclude?/2)\n\nSee [`REnum.ActiveSupport.exclude?/2`](REnum.ActiveSupport.html#exclude?/2).\n\n[excluding(arg1, arg2)](#excluding/2)\n\nSee [`REnum.ActiveSupport.excluding/2`](REnum.ActiveSupport.html#excluding/2).\n\n[fetch(arg1, arg2)](#fetch/2)\n\nSee [`Enum.fetch/2`](https://hexdocs.pm/elixir/Enum.html#fetch/2).\n\n[fetch!(arg1, arg2)](#fetch!/2)\n\nSee [`Enum.fetch!/2`](https://hexdocs.pm/elixir/Enum.html#fetch!/2).\n\n[filter(arg1, arg2)](#filter/2)\n\nSee [`Enum.filter/2`](https://hexdocs.pm/elixir/Enum.html#filter/2).\n\n[find(arg1, arg2)](#find/2)\n\nSee [`Enum.find/2`](https://hexdocs.pm/elixir/Enum.html#find/2).\n\n[find(arg1, arg2, arg3)](#find/3)\n\nSee [`Enum.find/3`](https://hexdocs.pm/elixir/Enum.html#find/3).\n\n[find_all(arg1, arg2)](#find_all/2)\n\nSee [`REnum.Ruby.find_all/2`](REnum.Ruby.html#find_all/2).\n\n[find_index(arg1, arg2)](#find_index/2)\n\nSee [`Enum.find_index/2`](https://hexdocs.pm/elixir/Enum.html#find_index/2).\n\n[find_index_with_index(arg1, arg2)](#find_index_with_index/2)\n\nSee [`REnum.Support.find_index_with_index/2`](REnum.Support.html#find_index_with_index/2).\n\n[find_value(arg1, arg2)](#find_value/2)\n\nSee [`Enum.find_value/2`](https://hexdocs.pm/elixir/Enum.html#find_value/2).\n\n[find_value(arg1, arg2, arg3)](#find_value/3)\n\nSee [`Enum.find_value/3`](https://hexdocs.pm/elixir/Enum.html#find_value/3).\n\n[first(arg1)](#first/1)\n\nSee [`REnum.Ruby.first/1`](REnum.Ruby.html#first/1).\n\n[first(arg1, arg2)](#first/2)\n\nSee [`REnum.Ruby.first/2`](REnum.Ruby.html#first/2).\n\n[flat_map(arg1, arg2)](#flat_map/2)\n\nSee [`Enum.flat_map/2`](https://hexdocs.pm/elixir/Enum.html#flat_map/2).\n\n[flat_map_reduce(arg1, arg2, arg3)](#flat_map_reduce/3)\n\nSee [`Enum.flat_map_reduce/3`](https://hexdocs.pm/elixir/Enum.html#flat_map_reduce/3).\n\n[frequencies(arg1)](#frequencies/1)\n\nSee [`Enum.frequencies/1`](https://hexdocs.pm/elixir/Enum.html#frequencies/1).\n\n[frequencies_by(arg1, arg2)](#frequencies_by/2)\n\nSee [`Enum.frequencies_by/2`](https://hexdocs.pm/elixir/Enum.html#frequencies_by/2).\n\n[grep(arg1, arg2)](#grep/2)\n\nSee [`REnum.Ruby.grep/2`](REnum.Ruby.html#grep/2).\n\n[grep(arg1, arg2, arg3)](#grep/3)\n\nSee [`REnum.Ruby.grep/3`](REnum.Ruby.html#grep/3).\n\n[grep_v(arg1, arg2)](#grep_v/2)\n\nSee [`REnum.Ruby.grep_v/2`](REnum.Ruby.html#grep_v/2).\n\n[grep_v(arg1, arg2, arg3)](#grep_v/3)\n\nSee [`REnum.Ruby.grep_v/3`](REnum.Ruby.html#grep_v/3).\n\n[group_by(arg1, arg2)](#group_by/2)\n\nSee [`Enum.group_by/2`](https://hexdocs.pm/elixir/Enum.html#group_by/2).\n\n[group_by(arg1, arg2, arg3)](#group_by/3)\n\nSee [`Enum.group_by/3`](https://hexdocs.pm/elixir/Enum.html#group_by/3).\n\n[in_order_of(arg1, arg2, arg3)](#in_order_of/3)\n\nSee [`REnum.ActiveSupport.in_order_of/3`](REnum.ActiveSupport.html#in_order_of/3).\n\n[include?(arg1, arg2)](#include?/2)\n\nSee [`REnum.Ruby.include?/2`](REnum.Ruby.html#include?/2).\n\n[including(arg1, arg2)](#including/2)\n\nSee [`REnum.ActiveSupport.including/2`](REnum.ActiveSupport.html#including/2).\n\n[index_by(arg1, arg2)](#index_by/2)\n\nSee [`REnum.ActiveSupport.index_by/2`](REnum.ActiveSupport.html#index_by/2).\n\n[index_with(arg1, arg2)](#index_with/2)\n\nSee [`REnum.ActiveSupport.index_with/2`](REnum.ActiveSupport.html#index_with/2).\n\n[inject(arg1, arg2)](#inject/2)\n\nSee [`REnum.Ruby.inject/2`](REnum.Ruby.html#inject/2).\n\n[inject(arg1, arg2, arg3)](#inject/3)\n\nSee [`REnum.Ruby.inject/3`](REnum.Ruby.html#inject/3).\n\n[intersperse(arg1, arg2)](#intersperse/2)\n\nSee [`Enum.intersperse/2`](https://hexdocs.pm/elixir/Enum.html#intersperse/2).\n\n[into(arg1, arg2)](#into/2)\n\nSee [`Enum.into/2`](https://hexdocs.pm/elixir/Enum.html#into/2).\n\n[into(arg1, arg2, arg3)](#into/3)\n\nSee [`Enum.into/3`](https://hexdocs.pm/elixir/Enum.html#into/3).\n\n[join(arg1)](#join/1)\n\nSee [`Enum.join/1`](https://hexdocs.pm/elixir/Enum.html#join/1).\n\n[join(arg1, arg2)](#join/2)\n\nSee [`Enum.join/2`](https://hexdocs.pm/elixir/Enum.html#join/2).\n\n[lazy(arg1)](#lazy/1)\n\nSee [`REnum.Ruby.lazy/1`](REnum.Ruby.html#lazy/1).\n\n[list_and_not_keyword?(arg1)](#list_and_not_keyword?/1)\n\nSee [`REnum.Support.list_and_not_keyword?/1`](REnum.Support.html#list_and_not_keyword?/1).\n\n[many?(arg1)](#many?/1)\n\nSee [`REnum.ActiveSupport.many?/1`](REnum.ActiveSupport.html#many?/1).\n\n[many?(arg1, arg2)](#many?/2)\n\nSee [`REnum.ActiveSupport.many?/2`](REnum.ActiveSupport.html#many?/2).\n\n[map(arg1, arg2)](#map/2)\n\nSee [`Enum.map/2`](https://hexdocs.pm/elixir/Enum.html#map/2).\n\n[map_and_not_range?(arg1)](#map_and_not_range?/1)\n\nSee [`REnum.Support.map_and_not_range?/1`](REnum.Support.html#map_and_not_range?/1).\n\n[map_every(arg1, arg2, arg3)](#map_every/3)\n\nSee [`Enum.map_every/3`](https://hexdocs.pm/elixir/Enum.html#map_every/3).\n\n[map_intersperse(arg1, arg2, arg3)](#map_intersperse/3)\n\nSee [`Enum.map_intersperse/3`](https://hexdocs.pm/elixir/Enum.html#map_intersperse/3).\n\n[map_join(arg1, arg2)](#map_join/2)\n\nSee [`Enum.map_join/2`](https://hexdocs.pm/elixir/Enum.html#map_join/2).\n\n[map_join(arg1, arg2, arg3)](#map_join/3)\n\nSee [`Enum.map_join/3`](https://hexdocs.pm/elixir/Enum.html#map_join/3).\n\n[map_reduce(arg1, arg2, arg3)](#map_reduce/3)\n\nSee [`Enum.map_reduce/3`](https://hexdocs.pm/elixir/Enum.html#map_reduce/3).\n\n[match_function(arg1)](#match_function/1)\n\nSee [`REnum.Support.match_function/1`](REnum.Support.html#match_function/1).\n\n[max(arg1)](#max/1)\n\nSee [`Enum.max/1`](https://hexdocs.pm/elixir/Enum.html#max/1).\n\n[max(arg1, arg2)](#max/2)\n\nSee [`Enum.max/2`](https://hexdocs.pm/elixir/Enum.html#max/2).\n\n[max(arg1, arg2, arg3)](#max/3)\n\nSee [`Enum.max/3`](https://hexdocs.pm/elixir/Enum.html#max/3).\n\n[max_by(arg1, arg2)](#max_by/2)\n\nSee [`Enum.max_by/2`](https://hexdocs.pm/elixir/Enum.html#max_by/2).\n\n[max_by(arg1, arg2, arg3)](#max_by/3)\n\nSee [`Enum.max_by/3`](https://hexdocs.pm/elixir/Enum.html#max_by/3).\n\n[max_by(arg1, arg2, arg3, arg4)](#max_by/4)\n\nSee [`Enum.max_by/4`](https://hexdocs.pm/elixir/Enum.html#max_by/4).\n\n[maximum(arg1, arg2)](#maximum/2)\n\nSee [`REnum.ActiveSupport.maximum/2`](REnum.ActiveSupport.html#maximum/2).\n\n[member?(arg1, arg2)](#member?/2)\n\nSee [`Enum.member?/2`](https://hexdocs.pm/elixir/Enum.html#member?/2).\n\n[min(arg1)](#min/1)\n\nSee [`Enum.min/1`](https://hexdocs.pm/elixir/Enum.html#min/1).\n\n[min(arg1, arg2)](#min/2)\n\nSee [`Enum.min/2`](https://hexdocs.pm/elixir/Enum.html#min/2).\n\n[min(arg1, arg2, arg3)](#min/3)\n\nSee [`Enum.min/3`](https://hexdocs.pm/elixir/Enum.html#min/3).\n\n[min_by(arg1, arg2)](#min_by/2)\n\nSee [`Enum.min_by/2`](https://hexdocs.pm/elixir/Enum.html#min_by/2).\n\n[min_by(arg1, arg2, arg3)](#min_by/3)\n\nSee [`Enum.min_by/3`](https://hexdocs.pm/elixir/Enum.html#min_by/3).\n\n[min_by(arg1, arg2, arg3, arg4)](#min_by/4)\n\nSee [`Enum.min_by/4`](https://hexdocs.pm/elixir/Enum.html#min_by/4).\n\n[min_max(arg1)](#min_max/1)\n\nSee [`Enum.min_max/1`](https://hexdocs.pm/elixir/Enum.html#min_max/1).\n\n[min_max(arg1, arg2)](#min_max/2)\n\nSee [`Enum.min_max/2`](https://hexdocs.pm/elixir/Enum.html#min_max/2).\n\n[min_max_by(arg1, arg2)](#min_max_by/2)\n\nSee [`Enum.min_max_by/2`](https://hexdocs.pm/elixir/Enum.html#min_max_by/2).\n\n[min_max_by(arg1, arg2, arg3)](#min_max_by/3)\n\nSee [`Enum.min_max_by/3`](https://hexdocs.pm/elixir/Enum.html#min_max_by/3).\n\n[min_max_by(arg1, arg2, arg3, arg4)](#min_max_by/4)\n\nSee [`Enum.min_max_by/4`](https://hexdocs.pm/elixir/Enum.html#min_max_by/4).\n\n[minimum(arg1, arg2)](#minimum/2)\n\nSee [`REnum.ActiveSupport.minimum/2`](REnum.ActiveSupport.html#minimum/2).\n\n[minmax(arg1)](#minmax/1)\n\nSee [`REnum.Ruby.minmax/1`](REnum.Ruby.html#minmax/1).\n\n[minmax(arg1, arg2)](#minmax/2)\n\nSee [`REnum.Ruby.minmax/2`](REnum.Ruby.html#minmax/2).\n\n[minmax_by(arg1, arg2)](#minmax_by/2)\n\nSee [`REnum.Ruby.minmax_by/2`](REnum.Ruby.html#minmax_by/2).\n\n[minmax_by(arg1, arg2, arg3)](#minmax_by/3)\n\nSee [`REnum.Ruby.minmax_by/3`](REnum.Ruby.html#minmax_by/3).\n\n[minmax_by(arg1, arg2, arg3, arg4)](#minmax_by/4)\n\nSee [`REnum.Ruby.minmax_by/4`](REnum.Ruby.html#minmax_by/4).\n\n[none?(arg1)](#none?/1)\n\nSee [`REnum.Ruby.none?/1`](REnum.Ruby.html#none?/1).\n\n[none?(arg1, arg2)](#none?/2)\n\nSee [`REnum.Ruby.none?/2`](REnum.Ruby.html#none?/2).\n\n[one?(arg1)](#one?/1)\n\nSee [`REnum.Ruby.one?/1`](REnum.Ruby.html#one?/1).\n\n[one?(arg1, arg2)](#one?/2)\n\nSee [`REnum.Ruby.one?/2`](REnum.Ruby.html#one?/2).\n\n[pick(arg1, arg2)](#pick/2)\n\nSee [`REnum.ActiveSupport.pick/2`](REnum.ActiveSupport.html#pick/2).\n\n[pluck(arg1, arg2)](#pluck/2)\n\nSee [`REnum.ActiveSupport.pluck/2`](REnum.ActiveSupport.html#pluck/2).\n\n[product(arg1)](#product/1)\n\nSee [`Enum.product/1`](https://hexdocs.pm/elixir/Enum.html#product/1).\n\n[random(arg1)](#random/1)\n\nSee [`Enum.random/1`](https://hexdocs.pm/elixir/Enum.html#random/1).\n\n[range?(arg1)](#range?/1)\n\nSee [`REnum.Support.range?/1`](REnum.Support.html#range?/1).\n\n[reduce(arg1, arg2)](#reduce/2)\n\nSee [`Enum.reduce/2`](https://hexdocs.pm/elixir/Enum.html#reduce/2).\n\n[reduce(arg1, arg2, arg3)](#reduce/3)\n\nSee [`Enum.reduce/3`](https://hexdocs.pm/elixir/Enum.html#reduce/3).\n\n[reduce_while(arg1, arg2, arg3)](#reduce_while/3)\n\nSee [`Enum.reduce_while/3`](https://hexdocs.pm/elixir/Enum.html#reduce_while/3).\n\n[reject(arg1, arg2)](#reject/2)\n\nSee [`Enum.reject/2`](https://hexdocs.pm/elixir/Enum.html#reject/2).\n\n[reverse(arg1)](#reverse/1)\n\nSee [`Enum.reverse/1`](https://hexdocs.pm/elixir/Enum.html#reverse/1).\n\n[reverse(arg1, arg2)](#reverse/2)\n\nSee [`Enum.reverse/2`](https://hexdocs.pm/elixir/Enum.html#reverse/2).\n\n[reverse_each(arg1, arg2)](#reverse_each/2)\n\nSee [`REnum.Ruby.reverse_each/2`](REnum.Ruby.html#reverse_each/2).\n\n[reverse_slice(arg1, arg2, arg3)](#reverse_slice/3)\n\nSee [`Enum.reverse_slice/3`](https://hexdocs.pm/elixir/Enum.html#reverse_slice/3).\n\n[scan(arg1, arg2)](#scan/2)\n\nSee [`Enum.scan/2`](https://hexdocs.pm/elixir/Enum.html#scan/2).\n\n[scan(arg1, arg2, arg3)](#scan/3)\n\nSee [`Enum.scan/3`](https://hexdocs.pm/elixir/Enum.html#scan/3).\n\n[select(arg1, arg2)](#select/2)\n\nSee [`REnum.Ruby.select/2`](REnum.Ruby.html#select/2).\n\n[shuffle(arg1)](#shuffle/1)\n\nSee [`Enum.shuffle/1`](https://hexdocs.pm/elixir/Enum.html#shuffle/1).\n\n[slice(arg1, arg2)](#slice/2)\n\nSee [`Enum.slice/2`](https://hexdocs.pm/elixir/Enum.html#slice/2).\n\n[slice(arg1, arg2, arg3)](#slice/3)\n\nSee [`Enum.slice/3`](https://hexdocs.pm/elixir/Enum.html#slice/3).\n\n[slice_after(arg1, arg2)](#slice_after/2)\n\nSee [`REnum.Ruby.slice_after/2`](REnum.Ruby.html#slice_after/2).\n\n[slice_before(arg1, arg2)](#slice_before/2)\n\nSee [`REnum.Ruby.slice_before/2`](REnum.Ruby.html#slice_before/2).\n\n[slice_when(arg1, arg2)](#slice_when/2)\n\nSee [`REnum.Ruby.slice_when/2`](REnum.Ruby.html#slice_when/2).\n\n[slide(arg1, arg2, arg3)](#slide/3)\n\nSee [`Enum.slide/3`](https://hexdocs.pm/elixir/Enum.html#slide/3).\n\n[sole(arg1)](#sole/1)\n\nSee [`REnum.ActiveSupport.sole/1`](REnum.ActiveSupport.html#sole/1).\n\n[sort(arg1)](#sort/1)\n\nSee [`Enum.sort/1`](https://hexdocs.pm/elixir/Enum.html#sort/1).\n\n[sort(arg1, arg2)](#sort/2)\n\nSee [`Enum.sort/2`](https://hexdocs.pm/elixir/Enum.html#sort/2).\n\n[sort_by(arg1, arg2)](#sort_by/2)\n\nSee [`Enum.sort_by/2`](https://hexdocs.pm/elixir/Enum.html#sort_by/2).\n\n[sort_by(arg1, arg2, arg3)](#sort_by/3)\n\nSee [`Enum.sort_by/3`](https://hexdocs.pm/elixir/Enum.html#sort_by/3).\n\n[split(arg1, arg2)](#split/2)\n\nSee [`Enum.split/2`](https://hexdocs.pm/elixir/Enum.html#split/2).\n\n[split_while(arg1, arg2)](#split_while/2)\n\nSee [`Enum.split_while/2`](https://hexdocs.pm/elixir/Enum.html#split_while/2).\n\n[split_with(arg1, arg2)](#split_with/2)\n\nSee [`Enum.split_with/2`](https://hexdocs.pm/elixir/Enum.html#split_with/2).\n\n[sum(arg1)](#sum/1)\n\nSee [`Enum.sum/1`](https://hexdocs.pm/elixir/Enum.html#sum/1).\n\n[take(arg1, arg2)](#take/2)\n\nSee [`Enum.take/2`](https://hexdocs.pm/elixir/Enum.html#take/2).\n\n[take_every(arg1, arg2)](#take_every/2)\n\nSee [`Enum.take_every/2`](https://hexdocs.pm/elixir/Enum.html#take_every/2).\n\n[take_random(arg1, arg2)](#take_random/2)\n\nSee [`Enum.take_random/2`](https://hexdocs.pm/elixir/Enum.html#take_random/2).\n\n[take_while(arg1, arg2)](#take_while/2)\n\nSee [`Enum.take_while/2`](https://hexdocs.pm/elixir/Enum.html#take_while/2).\n\n[tally(arg1)](#tally/1)\n\nSee [`REnum.Ruby.tally/1`](REnum.Ruby.html#tally/1).\n\n[to_a(arg1)](#to_a/1)\n\nSee [`REnum.Ruby.to_a/1`](REnum.Ruby.html#to_a/1).\n\n[to_h(arg1)](#to_h/1)\n\nSee [`REnum.Ruby.to_h/1`](REnum.Ruby.html#to_h/1).\n\n[to_h(arg1, arg2)](#to_h/2)\n\nSee [`REnum.Ruby.to_h/2`](REnum.Ruby.html#to_h/2).\n\n[to_l(arg1)](#to_l/1)\n\nSee [`REnum.Ruby.to_l/1`](REnum.Ruby.html#to_l/1).\n\n[to_list(arg1)](#to_list/1)\n\nSee [`Enum.to_list/1`](https://hexdocs.pm/elixir/Enum.html#to_list/1).\n\n[truthy_count(arg1)](#truthy_count/1)\n\nSee [`REnum.Support.truthy_count/1`](REnum.Support.html#truthy_count/1).\n\n[truthy_count(arg1, arg2)](#truthy_count/2)\n\nSee [`REnum.Support.truthy_count/2`](REnum.Support.html#truthy_count/2).\n\n[uniq_by(arg1, arg2)](#uniq_by/2)\n\nSee [`Enum.uniq_by/2`](https://hexdocs.pm/elixir/Enum.html#uniq_by/2).\n\n[unzip(arg1)](#unzip/1)\n\nSee [`Enum.unzip/1`](https://hexdocs.pm/elixir/Enum.html#unzip/1).\n\n[with_index(arg1)](#with_index/1)\n\nSee [`Enum.with_index/1`](https://hexdocs.pm/elixir/Enum.html#with_index/1).\n\n[with_index(arg1, arg2)](#with_index/2)\n\nSee [`Enum.with_index/2`](https://hexdocs.pm/elixir/Enum.html#with_index/2).\n\n[without(arg1, arg2)](#without/2)\n\nSee [`REnum.ActiveSupport.without/2`](REnum.ActiveSupport.html#without/2).\n\n[zip(arg1)](#zip/1)\n\nSee [`Enum.zip/1`](https://hexdocs.pm/elixir/Enum.html#zip/1).\n\n[zip(arg1, arg2)](#zip/2)\n\nSee [`Enum.zip/2`](https://hexdocs.pm/elixir/Enum.html#zip/2).\n\n[zip_reduce(arg1, arg2, arg3)](#zip_reduce/3)\n\nSee [`Enum.zip_reduce/3`](https://hexdocs.pm/elixir/Enum.html#zip_reduce/3).\n\n[zip_reduce(arg1, arg2, arg3, arg4)](#zip_reduce/4)\n\nSee [`Enum.zip_reduce/4`](https://hexdocs.pm/elixir/Enum.html#zip_reduce/4).\n\n[zip_with(arg1, arg2)](#zip_with/2)\n\nSee [`Enum.zip_with/2`](https://hexdocs.pm/elixir/Enum.html#zip_with/2).\n\n[zip_with(arg1, arg2, arg3)](#zip_with/3)\n\nSee [`Enum.zip_with/3`](https://hexdocs.pm/elixir/Enum.html#zip_with/3).\n\n[Link to this section](#functions)\nFunctions\n===\n\nREnum.ActiveSupport\n===\n\nSummarized all of Enumerable functions in Rails.ActiveSupport.\nIf a function with the same name already exists in Elixir, that is not implemented.\nDefines all of here functions when `use ActiveSupport`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Types](#types)\n---\n\n[type_enumerable()](#t:type_enumerable/0)\n\n[type_map_list()](#t:type_map_list/0)\n\n[type_pattern()](#t:type_pattern/0)\n\n[Functions](#functions)\n---\n\n[compact_blank(enumerable)](#compact_blank/1)\n\nReturns a new enumerable without the blank items.\nUses `RUtils.blank?` for determining if an item is blank.\n\n[exclude?(enumerable, element)](#exclude?/2)\n\nThe negative of the `Enum.member?`.\nReturns +true+ if the collection does not include the object.\n\n[excluding(enumerable, elements)](#excluding/2)\n\nReturns enumerable excluded the specified elements.\n\n[in_order_of(enumerable, key, series)](#in_order_of/3)\n\nReturns a list where the order has been set to that provided in the series, based on the key of the elements in the original enumerable.\n\n[including(enumerable, elements)](#including/2)\n\nReturns enumerable included the specified elements.\n\n[index_by(enumerable, key)](#index_by/2)\n\nConverts an enumerable to a mao, using the function result or key as the key and the element as the value.\n\n[index_with(keys, func)](#index_with/2)\n\nConvert an enumerable to a map, using the element as the key and the function result or given value as the value.\n\n[many?(enumerable)](#many?/1)\n\nReturns true if the enumerable has more than 1 element.\n\n[many?(enumerable, pattern_or_func)](#many?/2)\n\nReturns true if the enumerable has more than 1 element matched given function result or pattern.\n\n[maximum(map_list, key)](#maximum/2)\n\nCalculates the maximum from the extracted elements.\n\n[minimum(map_list, key)](#minimum/2)\n\nCalculates the minimum from the extracted elements.\n\n[pick(map_list, keys)](#pick/2)\n\nExtract the given key from the first element in the enumerable.\n\n[pluck(map_list, keys)](#pluck/2)\n\nExtract the given key from each element in the enumerable.\n\n[sole(enumerable)](#sole/1)\n\nReturns the sole item in the enumerable.\nIf there are no items, or more than one item, raises SoleItemExpectedError.\n\n[without(enumerable, elements)](#without/2)\n\nSee [`REnum.ActiveSupport.excluding/2`](#excluding/2).\n\n[Link to this section](#types)\nTypes\n===\n\n[Link to this section](#functions)\nFunctions\n===\n\nREnum.Native\n===\n\nA module defines all of native Enum functions when `use REnum.Native`.\n[See also.](https://hexdocs.pm/elixir/Enum.html)\n\nREnum.Ruby\n===\n\nSummarized all of Ruby's Enumerable functions.\nIf a function with the same name already exists in Elixir, that is not implemented.\nAlso, the function that returns Enumerator in Ruby is customized each behavior on the characteristics.\nDefines all of here functions when `use REnum.Ruby`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Types](#types)\n---\n\n[type_enumerable()](#t:type_enumerable/0)\n\n[type_pattern()](#t:type_pattern/0)\n\n[Functions](#functions)\n---\n\n[chain(enumerables)](#chain/1)\n\nSee [`Stream.concat/1`](https://hexdocs.pm/elixir/Stream.html#concat/1).\n\n[chain(first, second)](#chain/2)\n\nSee [`Stream.concat/2`](https://hexdocs.pm/elixir/Stream.html#concat/2).\n\n[collect(enumerable, func)](#collect/2)\n\nSee [`Enum.map/2`](https://hexdocs.pm/elixir/Enum.html#map/2).\n\n[collect_concat(enumerable, func)](#collect_concat/2)\n\nSee [`Enum.flat_map/2`](https://hexdocs.pm/elixir/Enum.html#flat_map/2).\n\n[compact(enumerable)](#compact/1)\n\nReturns an list of all non-nil elements.\n\n[cycle(enumerable, n, func)](#cycle/3)\n\nWhen called with positive integer argument n and a function, calls the block with each element, then does so again, until it has done so n times; returns given enumerable When called with a function and n is nil, returns Stream cycled forever.\n\n[detect(enumerable, func)](#detect/2)\n\nSee [`Enum.find/2`](https://hexdocs.pm/elixir/Enum.html#find/2).\n\n[detect(enumerable, default, func)](#detect/3)\n\nSee [`Enum.find/3`](https://hexdocs.pm/elixir/Enum.html#find/3).\n\n[each_cons(enumerable, n, func)](#each_cons/3)\n\nCalls the function with each successive overlapped n-list of elements; returns given enumerable.\n\n[each_entry(enumerable, func)](#each_entry/2)\n\nCalls the given function with each element, returns given enumerable\n\n[each_slice(enumerable, amount)](#each_slice/2)\n\nReturns Stream given enumerable sliced by each amount.\n\n[each_slice(enumerable, start_index, amount_or_func)](#each_slice/3)\n\nCalls the given function with each element, returns given enumerable.\n\n[each_with_index(enumerable)](#each_with_index/1)\n\nSee [`Enum.with_index/1`](https://hexdocs.pm/elixir/Enum.html#with_index/1).\n\n[each_with_index(enumerable, func)](#each_with_index/2)\n\nSee [`Enum.with_index/2`](https://hexdocs.pm/elixir/Enum.html#with_index/2).\n\n[each_with_object(enumerable, collectable, func)](#each_with_object/3)\n\nSee [`Enum.reduce/3`](https://hexdocs.pm/elixir/Enum.html#reduce/3).\n\n[entries(enumerable)](#entries/1)\n\nSee [`REnum.Ruby.to_a/1`](#to_a/1).\n\n[find_all(enumerable, func)](#find_all/2)\n\nSee [`Enum.filter/2`](https://hexdocs.pm/elixir/Enum.html#filter/2).\n\n[first(enumerable)](#first/1)\n\nReturns the first element.\n\n[first(enumerable, n)](#first/2)\n\nReturns leading elements.\n\n[grep(enumerable, func)](#grep/2)\n\nReturns elements selected by a given pattern or function.\n\n[grep(enumerable, pattern, func)](#grep/3)\n\nCalls the function with each matching element and returned.\n\n[grep_v(enumerable, pattern)](#grep_v/2)\n\nReturns elements rejected by a given pattern or function.\n\n[grep_v(enumerable, pattern, func)](#grep_v/3)\n\nCalls the function with each unmatching element and returned.\n\n[include?(enumerable, element)](#include?/2)\n\nSee [`Enum.member?/2`](https://hexdocs.pm/elixir/Enum.html#member?/2).\n\n[inject(enumerable, func)](#inject/2)\n\nSee [`Enum.reduce/2`](https://hexdocs.pm/elixir/Enum.html#reduce/2).\n\n[inject(enumerable, acc, func)](#inject/3)\n\nSee [`Enum.reduce/3`](https://hexdocs.pm/elixir/Enum.html#reduce/3).\n\n[lazy(enumerable)](#lazy/1)\n\nReturns Stream, which redefines most Enumerable functions to postpone enumeration and enumerate values only on an as-needed basis.\n\n[minmax(enumerable)](#minmax/1)\n\nSee [`Enum.min_max/1`](https://hexdocs.pm/elixir/Enum.html#min_max/1).\n\n[minmax(enumerable, func)](#minmax/2)\n\nSee [`Enum.min_max/2`](https://hexdocs.pm/elixir/Enum.html#min_max/2).\n\n[minmax_by(enumerable, func)](#minmax_by/2)\n\nSee [`Enum.min_max_by/2`](https://hexdocs.pm/elixir/Enum.html#min_max_by/2).\n\n[minmax_by(enumerable, func1, func2)](#minmax_by/3)\n\nSee [`Enum.min_max_by/3`](https://hexdocs.pm/elixir/Enum.html#min_max_by/3).\n\n[minmax_by(enumerable, func1, func2, func3)](#minmax_by/4)\n\nSee [`Enum.min_max_by/4`](https://hexdocs.pm/elixir/Enum.html#min_max_by/4).\n\n[none?(enumerable)](#none?/1)\n\nReturns true if enumerable does not include truthy value; false otherwise.\n\n[none?(enumerable, pattern_or_func)](#none?/2)\n\nReturns whether no element meets a given criterion.\n\n[one?(enumerable)](#one?/1)\n\nReturn true if enumerable has only one truthy element; false otherwise.\n\n[one?(enumerable, pattern_or_func)](#one?/2)\n\nReturns true if exactly one element meets a specified criterion; false otherwise.\n\n[reverse_each(enumerable, func)](#reverse_each/2)\n\nCalls the function with each element, but in reverse order; returns given enumerable.\n\n[select(enumerable, func)](#select/2)\n\nSee [`Enum.filter/2`](https://hexdocs.pm/elixir/Enum.html#filter/2).\n\n[slice_after(enumerable, func)](#slice_after/2)\n\nWith argument pattern, returns an elements that uses the pattern to partition elements into lists (“slices”).\nAn element ends the current slice if element matches pattern.\nWith a function, returns an elements that uses the function to partition elements into list.\nAn element ends the current slice if its function return is a truthy value.\n\n[slice_before(enumerable, func)](#slice_before/2)\n\nWith argument pattern, returns an elements that uses the pattern to partition elements into lists (“slices”).\nAn element begins a new slice if element matches pattern. (or if it is the first element).\nWith a function, returns an elements that uses the function to partition elements into list.\nAn element ends the current slice if its function return is a truthy value.\n\n[slice_when(enumerable, func)](#slice_when/2)\n\nThe returned elements uses the function to partition elements into lists (“slices”).\nIt calls the function with each element and its successor.\nBegins a new slice if and only if the function returns a truthy value.\n&1 is current_element and &2 is next_element in function arguments.\n\n[tally(enumerable)](#tally/1)\n\nSee [`Enum.frequencies/1`](https://hexdocs.pm/elixir/Enum.html#frequencies/1).\n\n[to_a(enumerables)](#to_a/1)\n\nSee [`Enum.to_list/1`](https://hexdocs.pm/elixir/Enum.html#to_list/1).\n\n[to_h(enumerable)](#to_h/1)\n\nReturns a map each of whose entries is the key-value pair formed from one of those list.\n\n[to_h(enumerable, func)](#to_h/2)\n\nThe function is called with each element.\nThe function should return a 2-element tuple which becomes a key-value pair in the returned map.\n\n[to_l(enumerables)](#to_l/1)\n\nSee [`Enum.to_list/1`](https://hexdocs.pm/elixir/Enum.html#to_list/1).\n\n[Link to this section](#types)\nTypes\n===\n\n[Link to this section](#functions)\nFunctions\n===\n\nREnum.Support\n===\n\nSummarized other useful functions related to enumerable.\nDefines all of here functions when `use REnum.Support`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Types](#types)\n---\n\n[type_enumerable()](#t:type_enumerable/0)\n\n[type_pattern()](#t:type_pattern/0)\n\n[Functions](#functions)\n---\n\n[find_index_with_index(enumerable, func)](#find_index_with_index/2)\n\nReturns the first element for which function(with each element index) returns a truthy value.\n\n[list_and_not_keyword?(enumerable)](#list_and_not_keyword?/1)\n\nReturns true if argument is list and not keyword list.\n\n[map_and_not_range?(enumerable)](#map_and_not_range?/1)\n\nReturns true if argument is map and not range.\n\n[match_function(pattern)](#match_function/1)\n\nReturns matching function required one argument by given pattern.\n\n[range?(arg1)](#range?/1)\n\nReturns true if argument is range.\n\n[truthy_count(enumerable)](#truthy_count/1)\n\nReturns truthy count.\n\n[truthy_count(enumerable, func)](#truthy_count/2)\n\nReturns truthy count that judged　by given function.\n\n[Link to this section](#types)\nTypes\n===\n\n[Link to this section](#functions)\nFunctions\n===\n\nRList\n===\n\nEntry point of List extensions, and can use all of RList.* and REnum functions.\nSee also.\n\n* [RList.Native](https://hexdocs.pm/r_enum/RList.Native.html#content)\n* [RList.Ruby](https://hexdocs.pm/r_enum/RList.Ruby.html#content)\n* [RList.ActiveSupport](https://hexdocs.pm/r_enum/RList.ActiveSupport.html#content)\n* [RList.Support](https://hexdocs.pm/r_enum/RList.SupportSupport.html#content)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html#content)\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[all?(arg1)](#all?/1)\n\nSee [`REnum.all?/1`](REnum.html#all?/1).\n\n[all?(arg1, arg2)](#all?/2)\n\nSee [`REnum.all?/2`](REnum.html#all?/2).\n\n[all_combination(arg1, arg2)](#all_combination/2)\n\nSee [`RList.Ruby.all_combination/2`](RList.Ruby.html#all_combination/2).\n\n[all_combination(arg1, arg2, arg3)](#all_combination/3)\n\nSee [`RList.Ruby.all_combination/3`](RList.Ruby.html#all_combination/3).\n\n[any?(arg1)](#any?/1)\n\nSee [`REnum.any?/1`](REnum.html#any?/1).\n\n[any?(arg1, arg2)](#any?/2)\n\nSee [`REnum.any?/2`](REnum.html#any?/2).\n\n[append(arg1, arg2)](#append/2)\n\nSee [`RList.Ruby.append/2`](RList.Ruby.html#append/2).\n\n[ascii_printable?(arg1)](#ascii_printable?/1)\n\nSee [`List.ascii_printable?/1`](https://hexdocs.pm/elixir/List.html#ascii_printable?/1).\n\n[ascii_printable?(arg1, arg2)](#ascii_printable?/2)\n\nSee [`List.ascii_printable?/2`](https://hexdocs.pm/elixir/List.html#ascii_printable?/2).\n\n[assoc(arg1, arg2)](#assoc/2)\n\nSee [`RList.Ruby.assoc/2`](RList.Ruby.html#assoc/2).\n\n[at(arg1, arg2)](#at/2)\n\nSee [`REnum.at/2`](REnum.html#at/2).\n\n[at(arg1, arg2, arg3)](#at/3)\n\nSee [`REnum.at/3`](REnum.html#at/3).\n\n[chain(arg1)](#chain/1)\n\nSee [`REnum.chain/1`](REnum.html#chain/1).\n\n[chain(arg1, arg2)](#chain/2)\n\nSee [`REnum.chain/2`](REnum.html#chain/2).\n\n[chunk_by(arg1, arg2)](#chunk_by/2)\n\nSee [`REnum.chunk_by/2`](REnum.html#chunk_by/2).\n\n[chunk_every(arg1, arg2)](#chunk_every/2)\n\nSee [`REnum.chunk_every/2`](REnum.html#chunk_every/2).\n\n[chunk_every(arg1, arg2, arg3)](#chunk_every/3)\n\nSee [`REnum.chunk_every/3`](REnum.html#chunk_every/3).\n\n[chunk_every(arg1, arg2, arg3, arg4)](#chunk_every/4)\n\nSee [`REnum.chunk_every/4`](REnum.html#chunk_every/4).\n\n[chunk_while(arg1, arg2, arg3, arg4)](#chunk_while/4)\n\nSee [`REnum.chunk_while/4`](REnum.html#chunk_while/4).\n\n[clear(arg1)](#clear/1)\n\nSee [`RList.Ruby.clear/1`](RList.Ruby.html#clear/1).\n\n[collect(arg1, arg2)](#collect/2)\n\nSee [`REnum.collect/2`](REnum.html#collect/2).\n\n[collect_concat(arg1, arg2)](#collect_concat/2)\n\nSee [`REnum.collect_concat/2`](REnum.html#collect_concat/2).\n\n[combination(arg1, arg2)](#combination/2)\n\nSee [`RList.Ruby.combination/2`](RList.Ruby.html#combination/2).\n\n[combination(arg1, arg2, arg3)](#combination/3)\n\nSee [`RList.Ruby.combination/3`](RList.Ruby.html#combination/3).\n\n[compact(arg1)](#compact/1)\n\nSee [`REnum.compact/1`](REnum.html#compact/1).\n\n[compact_blank(arg1)](#compact_blank/1)\n\nSee [`REnum.compact_blank/1`](REnum.html#compact_blank/1).\n\n[concat(arg1)](#concat/1)\n\nSee [`REnum.concat/1`](REnum.html#concat/1).\n\n[concat(arg1, arg2)](#concat/2)\n\nSee [`REnum.concat/2`](REnum.html#concat/2).\n\n[count(arg1)](#count/1)\n\nSee [`REnum.count/1`](REnum.html#count/1).\n\n[count(arg1, arg2)](#count/2)\n\nSee [`REnum.count/2`](REnum.html#count/2).\n\n[count_until(arg1, arg2)](#count_until/2)\n\nSee [`REnum.count_until/2`](REnum.html#count_until/2).\n\n[count_until(arg1, arg2, arg3)](#count_until/3)\n\nSee [`REnum.count_until/3`](REnum.html#count_until/3).\n\n[cycle(arg1, arg2, arg3)](#cycle/3)\n\nSee [`REnum.cycle/3`](REnum.html#cycle/3).\n\n[dedup(arg1)](#dedup/1)\n\nSee [`REnum.dedup/1`](REnum.html#dedup/1).\n\n[dedup_by(arg1, arg2)](#dedup_by/2)\n\nSee [`REnum.dedup_by/2`](REnum.html#dedup_by/2).\n\n[delete(arg1, arg2)](#delete/2)\n\nSee [`List.delete/2`](https://hexdocs.pm/elixir/List.html#delete/2).\n\n[delete_at(arg1, arg2)](#delete_at/2)\n\nSee [`List.delete_at/2`](https://hexdocs.pm/elixir/List.html#delete_at/2).\n\n[delete_if(arg1, arg2)](#delete_if/2)\n\nSee [`RList.Ruby.delete_if/2`](RList.Ruby.html#delete_if/2).\n\n[detect(arg1, arg2)](#detect/2)\n\nSee [`REnum.detect/2`](REnum.html#detect/2).\n\n[detect(arg1, arg2, arg3)](#detect/3)\n\nSee [`REnum.detect/3`](REnum.html#detect/3).\n\n[difference(arg1, arg2)](#difference/2)\n\nSee [`RList.Ruby.difference/2`](RList.Ruby.html#difference/2).\n\n[dig(arg1, arg2)](#dig/2)\n\nSee [`RList.Ruby.dig/2`](RList.Ruby.html#dig/2).\n\n[dig(arg1, arg2, arg3)](#dig/3)\n\nSee [`RList.Ruby.dig/3`](RList.Ruby.html#dig/3).\n\n[drop(arg1, arg2)](#drop/2)\n\nSee [`REnum.drop/2`](REnum.html#drop/2).\n\n[drop_every(arg1, arg2)](#drop_every/2)\n\nSee [`REnum.drop_every/2`](REnum.html#drop_every/2).\n\n[drop_while(arg1, arg2)](#drop_while/2)\n\nSee [`REnum.drop_while/2`](REnum.html#drop_while/2).\n\n[duplicate(arg1, arg2)](#duplicate/2)\n\nSee [`List.duplicate/2`](https://hexdocs.pm/elixir/List.html#duplicate/2).\n\n[each(arg1, arg2)](#each/2)\n\nSee [`REnum.each/2`](REnum.html#each/2).\n\n[each_cons(arg1, arg2, arg3)](#each_cons/3)\n\nSee [`REnum.each_cons/3`](REnum.html#each_cons/3).\n\n[each_entry(arg1, arg2)](#each_entry/2)\n\nSee [`REnum.each_entry/2`](REnum.html#each_entry/2).\n\n[each_index(arg1, arg2)](#each_index/2)\n\nSee [`RList.Ruby.each_index/2`](RList.Ruby.html#each_index/2).\n\n[each_slice(arg1, arg2)](#each_slice/2)\n\nSee [`REnum.each_slice/2`](REnum.html#each_slice/2).\n\n[each_slice(arg1, arg2, arg3)](#each_slice/3)\n\nSee [`REnum.each_slice/3`](REnum.html#each_slice/3).\n\n[each_with_index(arg1)](#each_with_index/1)\n\nSee [`REnum.each_with_index/1`](REnum.html#each_with_index/1).\n\n[each_with_index(arg1, arg2)](#each_with_index/2)\n\nSee [`REnum.each_with_index/2`](REnum.html#each_with_index/2).\n\n[each_with_object(arg1, arg2, arg3)](#each_with_object/3)\n\nSee [`REnum.each_with_object/3`](REnum.html#each_with_object/3).\n\n[empty?(arg1)](#empty?/1)\n\nSee [`REnum.empty?/1`](REnum.html#empty?/1).\n\n[entries(arg1)](#entries/1)\n\nSee [`REnum.entries/1`](REnum.html#entries/1).\n\n[eql?(arg1, arg2)](#eql?/2)\n\nSee [`RList.Ruby.eql?/2`](RList.Ruby.html#eql?/2).\n\n[exclude?(arg1, arg2)](#exclude?/2)\n\nSee [`REnum.exclude?/2`](REnum.html#exclude?/2).\n\n[excluding(arg1, arg2)](#excluding/2)\n\nSee [`REnum.excluding/2`](REnum.html#excluding/2).\n\n[fetch(arg1, arg2)](#fetch/2)\n\nSee [`REnum.fetch/2`](REnum.html#fetch/2).\n\n[fetch!(arg1, arg2)](#fetch!/2)\n\nSee [`REnum.fetch!/2`](REnum.html#fetch!/2).\n\n[fifth(arg1)](#fifth/1)\n\nSee [`RList.ActiveSupport.fifth/1`](RList.ActiveSupport.html#fifth/1).\n\n[fill(arg1, arg2)](#fill/2)\n\nSee [`RList.Ruby.fill/2`](RList.Ruby.html#fill/2).\n\n[fill(arg1, arg2, arg3)](#fill/3)\n\nSee [`RList.Ruby.fill/3`](RList.Ruby.html#fill/3).\n\n[filter(arg1, arg2)](#filter/2)\n\nSee [`REnum.filter/2`](REnum.html#filter/2).\n\n[find(arg1, arg2)](#find/2)\n\nSee [`REnum.find/2`](REnum.html#find/2).\n\n[find(arg1, arg2, arg3)](#find/3)\n\nSee [`REnum.find/3`](REnum.html#find/3).\n\n[find_all(arg1, arg2)](#find_all/2)\n\nSee [`REnum.find_all/2`](REnum.html#find_all/2).\n\n[find_index(arg1, arg2)](#find_index/2)\n\nSee [`REnum.find_index/2`](REnum.html#find_index/2).\n\n[find_index_with_index(arg1, arg2)](#find_index_with_index/2)\n\nSee [`REnum.find_index_with_index/2`](REnum.html#find_index_with_index/2).\n\n[find_value(arg1, arg2)](#find_value/2)\n\nSee [`REnum.find_value/2`](REnum.html#find_value/2).\n\n[find_value(arg1, arg2, arg3)](#find_value/3)\n\nSee [`REnum.find_value/3`](REnum.html#find_value/3).\n\n[first(arg1)](#first/1)\n\nSee [`List.first/1`](https://hexdocs.pm/elixir/List.html#first/1).\n\n[first(arg1, arg2)](#first/2)\n\nSee [`List.first/2`](https://hexdocs.pm/elixir/List.html#first/2).\n\n[flat_map(arg1, arg2)](#flat_map/2)\n\nSee [`REnum.flat_map/2`](REnum.html#flat_map/2).\n\n[flat_map_reduce(arg1, arg2, arg3)](#flat_map_reduce/3)\n\nSee [`REnum.flat_map_reduce/3`](REnum.html#flat_map_reduce/3).\n\n[flatten(arg1)](#flatten/1)\n\nSee [`List.flatten/1`](https://hexdocs.pm/elixir/List.html#flatten/1).\n\n[flatten(arg1, arg2)](#flatten/2)\n\nSee [`List.flatten/2`](https://hexdocs.pm/elixir/List.html#flatten/2).\n\n[foldl(arg1, arg2, arg3)](#foldl/3)\n\nSee [`List.foldl/3`](https://hexdocs.pm/elixir/List.html#foldl/3).\n\n[foldr(arg1, arg2, arg3)](#foldr/3)\n\nSee [`List.foldr/3`](https://hexdocs.pm/elixir/List.html#foldr/3).\n\n[forty_two(arg1)](#forty_two/1)\n\nSee [`RList.ActiveSupport.forty_two/1`](RList.ActiveSupport.html#forty_two/1).\n\n[fourth(arg1)](#fourth/1)\n\nSee [`RList.ActiveSupport.fourth/1`](RList.ActiveSupport.html#fourth/1).\n\n[frequencies(arg1)](#frequencies/1)\n\nSee [`REnum.frequencies/1`](REnum.html#frequencies/1).\n\n[frequencies_by(arg1, arg2)](#frequencies_by/2)\n\nSee [`REnum.frequencies_by/2`](REnum.html#frequencies_by/2).\n\n[from(arg1, arg2)](#from/2)\n\nSee [`RList.ActiveSupport.from/2`](RList.ActiveSupport.html#from/2).\n\n[grep(arg1, arg2)](#grep/2)\n\nSee [`REnum.grep/2`](REnum.html#grep/2).\n\n[grep(arg1, arg2, arg3)](#grep/3)\n\nSee [`REnum.grep/3`](REnum.html#grep/3).\n\n[grep_v(arg1, arg2)](#grep_v/2)\n\nSee [`REnum.grep_v/2`](REnum.html#grep_v/2).\n\n[grep_v(arg1, arg2, arg3)](#grep_v/3)\n\nSee [`REnum.grep_v/3`](REnum.html#grep_v/3).\n\n[group_by(arg1, arg2)](#group_by/2)\n\nSee [`REnum.group_by/2`](REnum.html#group_by/2).\n\n[group_by(arg1, arg2, arg3)](#group_by/3)\n\nSee [`REnum.group_by/3`](REnum.html#group_by/3).\n\n[improper?(arg1)](#improper?/1)\n\nSee [`List.improper?/1`](https://hexdocs.pm/elixir/List.html#improper?/1).\n\n[in_groups(arg1, arg2)](#in_groups/2)\n\nSee [`RList.ActiveSupport.in_groups/2`](RList.ActiveSupport.html#in_groups/2).\n\n[in_groups(arg1, arg2, arg3)](#in_groups/3)\n\nSee [`RList.ActiveSupport.in_groups/3`](RList.ActiveSupport.html#in_groups/3).\n\n[in_groups_of(arg1, arg2)](#in_groups_of/2)\n\nSee [`RList.ActiveSupport.in_groups_of/2`](RList.ActiveSupport.html#in_groups_of/2).\n\n[in_groups_of(arg1, arg2, arg3)](#in_groups_of/3)\n\nSee [`RList.ActiveSupport.in_groups_of/3`](RList.ActiveSupport.html#in_groups_of/3).\n\n[in_order_of(arg1, arg2, arg3)](#in_order_of/3)\n\nSee [`REnum.in_order_of/3`](REnum.html#in_order_of/3).\n\n[include?(arg1, arg2)](#include?/2)\n\nSee [`REnum.include?/2`](REnum.html#include?/2).\n\n[including(arg1, arg2)](#including/2)\n\nSee [`REnum.including/2`](REnum.html#including/2).\n\n[index(arg1, arg2)](#index/2)\n\nSee [`RList.Ruby.index/2`](RList.Ruby.html#index/2).\n\n[index_by(arg1, arg2)](#index_by/2)\n\nSee [`REnum.index_by/2`](REnum.html#index_by/2).\n\n[index_with(arg1, arg2)](#index_with/2)\n\nSee [`REnum.index_with/2`](REnum.html#index_with/2).\n\n[inject(arg1, arg2)](#inject/2)\n\nSee [`REnum.inject/2`](REnum.html#inject/2).\n\n[inject(arg1, arg2, arg3)](#inject/3)\n\nSee [`REnum.inject/3`](REnum.html#inject/3).\n\n[insert(arg1, arg2, arg3)](#insert/3)\n\nSee [`RList.Ruby.insert/3`](RList.Ruby.html#insert/3).\n\n[insert_at(arg1, arg2, arg3)](#insert_at/3)\n\nSee [`List.insert_at/3`](https://hexdocs.pm/elixir/List.html#insert_at/3).\n\n[inspect(arg1)](#inspect/1)\n\nSee [`RList.Ruby.inspect/1`](RList.Ruby.html#inspect/1).\n\n[intersect?(arg1, arg2)](#intersect?/2)\n\nSee [`RList.Ruby.intersect?/2`](RList.Ruby.html#intersect?/2).\n\n[intersection(arg1, arg2)](#intersection/2)\n\nSee [`RList.Ruby.intersection/2`](RList.Ruby.html#intersection/2).\n\n[intersperse(arg1, arg2)](#intersperse/2)\n\nSee [`REnum.intersperse/2`](REnum.html#intersperse/2).\n\n[into(arg1, arg2)](#into/2)\n\nSee [`REnum.into/2`](REnum.html#into/2).\n\n[into(arg1, arg2, arg3)](#into/3)\n\nSee [`REnum.into/3`](REnum.html#into/3).\n\n[join(arg1)](#join/1)\n\nSee [`REnum.join/1`](REnum.html#join/1).\n\n[join(arg1, arg2)](#join/2)\n\nSee [`REnum.join/2`](REnum.html#join/2).\n\n[keep_if(arg1, arg2)](#keep_if/2)\n\nSee [`RList.Ruby.keep_if/2`](RList.Ruby.html#keep_if/2).\n\n[keydelete(arg1, arg2, arg3)](#keydelete/3)\n\nSee [`List.keydelete/3`](https://hexdocs.pm/elixir/List.html#keydelete/3).\n\n[keyfind(arg1, arg2, arg3)](#keyfind/3)\n\nSee [`List.keyfind/3`](https://hexdocs.pm/elixir/List.html#keyfind/3).\n\n[keyfind(arg1, arg2, arg3, arg4)](#keyfind/4)\n\nSee [`List.keyfind/4`](https://hexdocs.pm/elixir/List.html#keyfind/4).\n\n[keyfind!(arg1, arg2, arg3)](#keyfind!/3)\n\nSee [`List.keyfind!/3`](https://hexdocs.pm/elixir/List.html#keyfind!/3).\n\n[keymember?(arg1, arg2, arg3)](#keymember?/3)\n\nSee [`List.keymember?/3`](https://hexdocs.pm/elixir/List.html#keymember?/3).\n\n[keyreplace(arg1, arg2, arg3, arg4)](#keyreplace/4)\n\nSee [`List.keyreplace/4`](https://hexdocs.pm/elixir/List.html#keyreplace/4).\n\n[keysort(arg1, arg2)](#keysort/2)\n\nSee [`List.keysort/2`](https://hexdocs.pm/elixir/List.html#keysort/2).\n\n[keystore(arg1, arg2, arg3, arg4)](#keystore/4)\n\nSee [`List.keystore/4`](https://hexdocs.pm/elixir/List.html#keystore/4).\n\n[keytake(arg1, arg2, arg3)](#keytake/3)\n\nSee [`List.keytake/3`](https://hexdocs.pm/elixir/List.html#keytake/3).\n\n[last(arg1)](#last/1)\n\nSee [`List.last/1`](https://hexdocs.pm/elixir/List.html#last/1).\n\n[last(arg1, arg2)](#last/2)\n\nSee [`List.last/2`](https://hexdocs.pm/elixir/List.html#last/2).\n\n[lazy(arg1)](#lazy/1)\n\nSee [`REnum.lazy/1`](REnum.html#lazy/1).\n\n[length(arg1)](#length/1)\n\nSee [`RList.Ruby.length/1`](RList.Ruby.html#length/1).\n\n[list_and_not_keyword?(arg1)](#list_and_not_keyword?/1)\n\nSee [`REnum.list_and_not_keyword?/1`](REnum.html#list_and_not_keyword?/1).\n\n[many?(arg1)](#many?/1)\n\nSee [`REnum.many?/1`](REnum.html#many?/1).\n\n[many?(arg1, arg2)](#many?/2)\n\nSee [`REnum.many?/2`](REnum.html#many?/2).\n\n[map(arg1, arg2)](#map/2)\n\nSee [`REnum.map/2`](REnum.html#map/2).\n\n[map_and_not_range?(arg1)](#map_and_not_range?/1)\n\nSee [`REnum.map_and_not_range?/1`](REnum.html#map_and_not_range?/1).\n\n[map_every(arg1, arg2, arg3)](#map_every/3)\n\nSee [`REnum.map_every/3`](REnum.html#map_every/3).\n\n[map_intersperse(arg1, arg2, arg3)](#map_intersperse/3)\n\nSee [`REnum.map_intersperse/3`](REnum.html#map_intersperse/3).\n\n[map_join(arg1, arg2)](#map_join/2)\n\nSee [`REnum.map_join/2`](REnum.html#map_join/2).\n\n[map_join(arg1, arg2, arg3)](#map_join/3)\n\nSee [`REnum.map_join/3`](REnum.html#map_join/3).\n\n[map_reduce(arg1, arg2, arg3)](#map_reduce/3)\n\nSee [`REnum.map_reduce/3`](REnum.html#map_reduce/3).\n\n[match_function(arg1)](#match_function/1)\n\nSee [`REnum.match_function/1`](REnum.html#match_function/1).\n\n[max(arg1)](#max/1)\n\nSee [`REnum.max/1`](REnum.html#max/1).\n\n[max(arg1, arg2)](#max/2)\n\nSee [`REnum.max/2`](REnum.html#max/2).\n\n[max(arg1, arg2, arg3)](#max/3)\n\nSee [`REnum.max/3`](REnum.html#max/3).\n\n[max_by(arg1, arg2)](#max_by/2)\n\nSee [`REnum.max_by/2`](REnum.html#max_by/2).\n\n[max_by(arg1, arg2, arg3)](#max_by/3)\n\nSee [`REnum.max_by/3`](REnum.html#max_by/3).\n\n[max_by(arg1, arg2, arg3, arg4)](#max_by/4)\n\nSee [`REnum.max_by/4`](REnum.html#max_by/4).\n\n[maximum(arg1, arg2)](#maximum/2)\n\nSee [`REnum.maximum/2`](REnum.html#maximum/2).\n\n[member?(arg1, arg2)](#member?/2)\n\nSee [`REnum.member?/2`](REnum.html#member?/2).\n\n[min(arg1)](#min/1)\n\nSee [`REnum.min/1`](REnum.html#min/1).\n\n[min(arg1, arg2)](#min/2)\n\nSee [`REnum.min/2`](REnum.html#min/2).\n\n[min(arg1, arg2, arg3)](#min/3)\n\nSee [`REnum.min/3`](REnum.html#min/3).\n\n[min_by(arg1, arg2)](#min_by/2)\n\nSee [`REnum.min_by/2`](REnum.html#min_by/2).\n\n[min_by(arg1, arg2, arg3)](#min_by/3)\n\nSee [`REnum.min_by/3`](REnum.html#min_by/3).\n\n[min_by(arg1, arg2, arg3, arg4)](#min_by/4)\n\nSee [`REnum.min_by/4`](REnum.html#min_by/4).\n\n[min_max(arg1)](#min_max/1)\n\nSee [`REnum.min_max/1`](REnum.html#min_max/1).\n\n[min_max(arg1, arg2)](#min_max/2)\n\nSee [`REnum.min_max/2`](REnum.html#min_max/2).\n\n[min_max_by(arg1, arg2)](#min_max_by/2)\n\nSee [`REnum.min_max_by/2`](REnum.html#min_max_by/2).\n\n[min_max_by(arg1, arg2, arg3)](#min_max_by/3)\n\nSee [`REnum.min_max_by/3`](REnum.html#min_max_by/3).\n\n[min_max_by(arg1, arg2, arg3, arg4)](#min_max_by/4)\n\nSee [`REnum.min_max_by/4`](REnum.html#min_max_by/4).\n\n[minimum(arg1, arg2)](#minimum/2)\n\nSee [`REnum.minimum/2`](REnum.html#minimum/2).\n\n[minmax(arg1)](#minmax/1)\n\nSee [`REnum.minmax/1`](REnum.html#minmax/1).\n\n[minmax(arg1, arg2)](#minmax/2)\n\nSee [`REnum.minmax/2`](REnum.html#minmax/2).\n\n[minmax_by(arg1, arg2)](#minmax_by/2)\n\nSee [`REnum.minmax_by/2`](REnum.html#minmax_by/2).\n\n[minmax_by(arg1, arg2, arg3)](#minmax_by/3)\n\nSee [`REnum.minmax_by/3`](REnum.html#minmax_by/3).\n\n[minmax_by(arg1, arg2, arg3, arg4)](#minmax_by/4)\n\nSee [`REnum.minmax_by/4`](REnum.html#minmax_by/4).\n\n[myers_difference(arg1, arg2)](#myers_difference/2)\n\nSee [`List.myers_difference/2`](https://hexdocs.pm/elixir/List.html#myers_difference/2).\n\n[myers_difference(arg1, arg2, arg3)](#myers_difference/3)\n\nSee [`List.myers_difference/3`](https://hexdocs.pm/elixir/List.html#myers_difference/3).\n\n[new(arg1)](#new/1)\n\nSee [`RList.Support.new/1`](RList.Support.html#new/1).\n\n[new(arg1, arg2)](#new/2)\n\nSee [`RList.Support.new/2`](RList.Support.html#new/2).\n\n[none?(arg1)](#none?/1)\n\nSee [`REnum.none?/1`](REnum.html#none?/1).\n\n[none?(arg1, arg2)](#none?/2)\n\nSee [`REnum.none?/2`](REnum.html#none?/2).\n\n[one?(arg1)](#one?/1)\n\nSee [`REnum.one?/1`](REnum.html#one?/1).\n\n[one?(arg1, arg2)](#one?/2)\n\nSee [`REnum.one?/2`](REnum.html#one?/2).\n\n[permutation(arg1)](#permutation/1)\n\nSee [`RList.Ruby.permutation/1`](RList.Ruby.html#permutation/1).\n\n[permutation(arg1, arg2)](#permutation/2)\n\nSee [`RList.Ruby.permutation/2`](RList.Ruby.html#permutation/2).\n\n[pick(arg1, arg2)](#pick/2)\n\nSee [`REnum.pick/2`](REnum.html#pick/2).\n\n[pluck(arg1, arg2)](#pluck/2)\n\nSee [`REnum.pluck/2`](REnum.html#pluck/2).\n\n[pop(arg1)](#pop/1)\n\nSee [`RList.Ruby.pop/1`](RList.Ruby.html#pop/1).\n\n[pop(arg1, arg2)](#pop/2)\n\nSee [`RList.Ruby.pop/2`](RList.Ruby.html#pop/2).\n\n[pop_at(arg1, arg2)](#pop_at/2)\n\nSee [`List.pop_at/2`](https://hexdocs.pm/elixir/List.html#pop_at/2).\n\n[pop_at(arg1, arg2, arg3)](#pop_at/3)\n\nSee [`List.pop_at/3`](https://hexdocs.pm/elixir/List.html#pop_at/3).\n\n[prepend(arg1)](#prepend/1)\n\nSee [`RList.Ruby.prepend/1`](RList.Ruby.html#prepend/1).\n\n[prepend(arg1, arg2)](#prepend/2)\n\nSee [`RList.Ruby.prepend/2`](RList.Ruby.html#prepend/2).\n\n[product(arg1)](#product/1)\n\nSee [`REnum.product/1`](REnum.html#product/1).\n\n[push(arg1, arg2)](#push/2)\n\nSee [`RList.Ruby.push/2`](RList.Ruby.html#push/2).\n\n[random(arg1)](#random/1)\n\nSee [`REnum.random/1`](REnum.html#random/1).\n\n[range?(arg1)](#range?/1)\n\nSee [`REnum.range?/1`](REnum.html#range?/1).\n\n[rassoc(arg1, arg2)](#rassoc/2)\n\nSee [`RList.Ruby.rassoc/2`](RList.Ruby.html#rassoc/2).\n\n[reduce(arg1, arg2)](#reduce/2)\n\nSee [`REnum.reduce/2`](REnum.html#reduce/2).\n\n[reduce(arg1, arg2, arg3)](#reduce/3)\n\nSee [`REnum.reduce/3`](REnum.html#reduce/3).\n\n[reduce_while(arg1, arg2, arg3)](#reduce_while/3)\n\nSee [`REnum.reduce_while/3`](REnum.html#reduce_while/3).\n\n[reject(arg1, arg2)](#reject/2)\n\nSee [`REnum.reject/2`](REnum.html#reject/2).\n\n[repeated_combination(arg1, arg2)](#repeated_combination/2)\n\nSee [`RList.Ruby.repeated_combination/2`](RList.Ruby.html#repeated_combination/2).\n\n[repeated_combination(arg1, arg2, arg3)](#repeated_combination/3)\n\nSee [`RList.Ruby.repeated_combination/3`](RList.Ruby.html#repeated_combination/3).\n\n[repeated_permutation(arg1, arg2)](#repeated_permutation/2)\n\nSee [`RList.Ruby.repeated_permutation/2`](RList.Ruby.html#repeated_permutation/2).\n\n[replace_at(arg1, arg2, arg3)](#replace_at/3)\n\nSee [`List.replace_at/3`](https://hexdocs.pm/elixir/List.html#replace_at/3).\n\n[reverse(arg1)](#reverse/1)\n\nSee [`REnum.reverse/1`](REnum.html#reverse/1).\n\n[reverse(arg1, arg2)](#reverse/2)\n\nSee [`REnum.reverse/2`](REnum.html#reverse/2).\n\n[reverse_each(arg1, arg2)](#reverse_each/2)\n\nSee [`REnum.reverse_each/2`](REnum.html#reverse_each/2).\n\n[reverse_slice(arg1, arg2, arg3)](#reverse_slice/3)\n\nSee [`REnum.reverse_slice/3`](REnum.html#reverse_slice/3).\n\n[rindex(arg1, arg2)](#rindex/2)\n\nSee [`RList.Ruby.rindex/2`](RList.Ruby.html#rindex/2).\n\n[rotate(arg1)](#rotate/1)\n\nSee [`RList.Ruby.rotate/1`](RList.Ruby.html#rotate/1).\n\n[rotate(arg1, arg2)](#rotate/2)\n\nSee [`RList.Ruby.rotate/2`](RList.Ruby.html#rotate/2).\n\n[sample(arg1)](#sample/1)\n\nSee [`RList.Ruby.sample/1`](RList.Ruby.html#sample/1).\n\n[sample(arg1, arg2)](#sample/2)\n\nSee [`RList.Ruby.sample/2`](RList.Ruby.html#sample/2).\n\n[scan(arg1, arg2)](#scan/2)\n\nSee [`REnum.scan/2`](REnum.html#scan/2).\n\n[scan(arg1, arg2, arg3)](#scan/3)\n\nSee [`REnum.scan/3`](REnum.html#scan/3).\n\n[second(arg1)](#second/1)\n\nSee [`RList.ActiveSupport.second/1`](RList.ActiveSupport.html#second/1).\n\n[second_to_last(arg1)](#second_to_last/1)\n\nSee [`RList.ActiveSupport.second_to_last/1`](RList.ActiveSupport.html#second_to_last/1).\n\n[select(arg1, arg2)](#select/2)\n\nSee [`REnum.select/2`](REnum.html#select/2).\n\n[shift(arg1)](#shift/1)\n\nSee [`RList.Ruby.shift/1`](RList.Ruby.html#shift/1).\n\n[shift(arg1, arg2)](#shift/2)\n\nSee [`RList.Ruby.shift/2`](RList.Ruby.html#shift/2).\n\n[shuffle(arg1)](#shuffle/1)\n\nSee [`REnum.shuffle/1`](REnum.html#shuffle/1).\n\n[size(arg1)](#size/1)\n\nSee [`RList.Ruby.size/1`](RList.Ruby.html#size/1).\n\n[slice(arg1, arg2)](#slice/2)\n\nSee [`REnum.slice/2`](REnum.html#slice/2).\n\n[slice(arg1, arg2, arg3)](#slice/3)\n\nSee [`REnum.slice/3`](REnum.html#slice/3).\n\n[slice_after(arg1, arg2)](#slice_after/2)\n\nSee [`REnum.slice_after/2`](REnum.html#slice_after/2).\n\n[slice_before(arg1, arg2)](#slice_before/2)\n\nSee [`REnum.slice_before/2`](REnum.html#slice_before/2).\n\n[slice_when(arg1, arg2)](#slice_when/2)\n\nSee [`REnum.slice_when/2`](REnum.html#slice_when/2).\n\n[slide(arg1, arg2, arg3)](#slide/3)\n\nSee [`REnum.slide/3`](REnum.html#slide/3).\n\n[sole(arg1)](#sole/1)\n\nSee [`REnum.sole/1`](REnum.html#sole/1).\n\n[sort(arg1)](#sort/1)\n\nSee [`REnum.sort/1`](REnum.html#sort/1).\n\n[sort(arg1, arg2)](#sort/2)\n\nSee [`REnum.sort/2`](REnum.html#sort/2).\n\n[sort_by(arg1, arg2)](#sort_by/2)\n\nSee [`REnum.sort_by/2`](REnum.html#sort_by/2).\n\n[sort_by(arg1, arg2, arg3)](#sort_by/3)\n\nSee [`REnum.sort_by/3`](REnum.html#sort_by/3).\n\n[split(arg1, arg2)](#split/2)\n\nSee [`REnum.split/2`](REnum.html#split/2).\n\n[split_while(arg1, arg2)](#split_while/2)\n\nSee [`REnum.split_while/2`](REnum.html#split_while/2).\n\n[split_with(arg1, arg2)](#split_with/2)\n\nSee [`REnum.split_with/2`](REnum.html#split_with/2).\n\n[starts_with?(arg1, arg2)](#starts_with?/2)\n\nSee [`List.starts_with?/2`](https://hexdocs.pm/elixir/List.html#starts_with?/2).\n\n[sum(arg1)](#sum/1)\n\nSee [`REnum.sum/1`](REnum.html#sum/1).\n\n[take(arg1, arg2)](#take/2)\n\nSee [`REnum.take/2`](REnum.html#take/2).\n\n[take_every(arg1, arg2)](#take_every/2)\n\nSee [`REnum.take_every/2`](REnum.html#take_every/2).\n\n[take_random(arg1, arg2)](#take_random/2)\n\nSee [`REnum.take_random/2`](REnum.html#take_random/2).\n\n[take_while(arg1, arg2)](#take_while/2)\n\nSee [`REnum.take_while/2`](REnum.html#take_while/2).\n\n[tally(arg1)](#tally/1)\n\nSee [`REnum.tally/1`](REnum.html#tally/1).\n\n[third(arg1)](#third/1)\n\nSee [`RList.ActiveSupport.third/1`](RList.ActiveSupport.html#third/1).\n\n[third_to_last(arg1)](#third_to_last/1)\n\nSee [`RList.ActiveSupport.third_to_last/1`](RList.ActiveSupport.html#third_to_last/1).\n\n[to(arg1, arg2)](#to/2)\n\nSee [`RList.ActiveSupport.to/2`](RList.ActiveSupport.html#to/2).\n\n[to_a(arg1)](#to_a/1)\n\nSee [`REnum.to_a/1`](REnum.html#to_a/1).\n\n[to_ary(arg1)](#to_ary/1)\n\nSee [`RList.Ruby.to_ary/1`](RList.Ruby.html#to_ary/1).\n\n[to_atom(arg1)](#to_atom/1)\n\nSee [`List.to_atom/1`](https://hexdocs.pm/elixir/List.html#to_atom/1).\n\n[to_charlist(arg1)](#to_charlist/1)\n\nSee [`List.to_charlist/1`](https://hexdocs.pm/elixir/List.html#to_charlist/1).\n\n[to_default_s(arg1)](#to_default_s/1)\n\nSee [`RList.ActiveSupport.to_default_s/1`](RList.ActiveSupport.html#to_default_s/1).\n\n[to_existing_atom(arg1)](#to_existing_atom/1)\n\nSee [`List.to_existing_atom/1`](https://hexdocs.pm/elixir/List.html#to_existing_atom/1).\n\n[to_float(arg1)](#to_float/1)\n\nSee [`List.to_float/1`](https://hexdocs.pm/elixir/List.html#to_float/1).\n\n[to_h(arg1)](#to_h/1)\n\nSee [`REnum.to_h/1`](REnum.html#to_h/1).\n\n[to_h(arg1, arg2)](#to_h/2)\n\nSee [`REnum.to_h/2`](REnum.html#to_h/2).\n\n[to_integer(arg1)](#to_integer/1)\n\nSee [`List.to_integer/1`](https://hexdocs.pm/elixir/List.html#to_integer/1).\n\n[to_integer(arg1, arg2)](#to_integer/2)\n\nSee [`List.to_integer/2`](https://hexdocs.pm/elixir/List.html#to_integer/2).\n\n[to_l(arg1)](#to_l/1)\n\nSee [`REnum.to_l/1`](REnum.html#to_l/1).\n\n[to_list(arg1)](#to_list/1)\n\nSee [`REnum.to_list/1`](REnum.html#to_list/1).\n\n[to_s(arg1)](#to_s/1)\n\nSee [`RList.Ruby.to_s/1`](RList.Ruby.html#to_s/1).\n\n[to_sentence(arg1)](#to_sentence/1)\n\nSee [`RList.ActiveSupport.to_sentence/1`](RList.ActiveSupport.html#to_sentence/1).\n\n[to_sentence(arg1, arg2)](#to_sentence/2)\n\nSee [`RList.ActiveSupport.to_sentence/2`](RList.ActiveSupport.html#to_sentence/2).\n\n[to_string(arg1)](#to_string/1)\n\nSee [`List.to_string/1`](https://hexdocs.pm/elixir/List.html#to_string/1).\n\n[to_tuple(arg1)](#to_tuple/1)\n\nSee [`List.to_tuple/1`](https://hexdocs.pm/elixir/List.html#to_tuple/1).\n\n[transpose(arg1)](#transpose/1)\n\nSee [`RList.Ruby.transpose/1`](RList.Ruby.html#transpose/1).\n\n[truthy_count(arg1)](#truthy_count/1)\n\nSee [`REnum.truthy_count/1`](REnum.html#truthy_count/1).\n\n[truthy_count(arg1, arg2)](#truthy_count/2)\n\nSee [`REnum.truthy_count/2`](REnum.html#truthy_count/2).\n\n[union(arg1, arg2)](#union/2)\n\nSee [`RList.Ruby.union/2`](RList.Ruby.html#union/2).\n\n[uniq_by(arg1, arg2)](#uniq_by/2)\n\nSee [`REnum.uniq_by/2`](REnum.html#uniq_by/2).\n\n[unshift(arg1, arg2)](#unshift/2)\n\nSee [`RList.Ruby.unshift/2`](RList.Ruby.html#unshift/2).\n\n[unzip(arg1)](#unzip/1)\n\nSee [`REnum.unzip/1`](REnum.html#unzip/1).\n\n[update_at(arg1, arg2, arg3)](#update_at/3)\n\nSee [`List.update_at/3`](https://hexdocs.pm/elixir/List.html#update_at/3).\n\n[values_at(arg1, arg2)](#values_at/2)\n\nSee [`RList.Ruby.values_at/2`](RList.Ruby.html#values_at/2).\n\n[with_index(arg1)](#with_index/1)\n\nSee [`REnum.with_index/1`](REnum.html#with_index/1).\n\n[with_index(arg1, arg2)](#with_index/2)\n\nSee [`REnum.with_index/2`](REnum.html#with_index/2).\n\n[without(arg1, arg2)](#without/2)\n\nSee [`REnum.without/2`](REnum.html#without/2).\n\n[wrap(arg1)](#wrap/1)\n\nSee [`List.wrap/1`](https://hexdocs.pm/elixir/List.html#wrap/1).\n\n[zip(arg1)](#zip/1)\n\nSee [`List.zip/1`](https://hexdocs.pm/elixir/List.html#zip/1).\n\n[zip_reduce(arg1, arg2, arg3)](#zip_reduce/3)\n\nSee [`REnum.zip_reduce/3`](REnum.html#zip_reduce/3).\n\n[zip_reduce(arg1, arg2, arg3, arg4)](#zip_reduce/4)\n\nSee [`REnum.zip_reduce/4`](REnum.html#zip_reduce/4).\n\n[zip_with(arg1, arg2)](#zip_with/2)\n\nSee [`REnum.zip_with/2`](REnum.html#zip_with/2).\n\n[zip_with(arg1, arg2, arg3)](#zip_with/3)\n\nSee [`REnum.zip_with/3`](REnum.html#zip_with/3).\n\n[Link to this section](#functions)\nFunctions\n===\n\nRList.ActiveSupport\n===\n\nSummarized all of List functions in Rails.ActiveSupport.\nIf a function with the same name already exists in Elixir, that is not implemented.\nDefines all of here functions when `use RList.ActiveSupport`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[fifth(list)](#fifth/1)\n\nEqual to `Enum.at(list, 4)`.\n\n[forty_two(list)](#forty_two/1)\n\nEqual to `Enum.at(list, 41)`. Also known as accessing \"the reddit\".\n\n[fourth(list)](#fourth/1)\n\nEqual to `Enum.at(list, 3)`.\n\n[from(list, position)](#from/2)\n\nReturns the tail of the list from position.\n\n[in_groups(list, number, fill_with \\\\ nil)](#in_groups/3)\n\nSplits or iterates over the list in number of groups, padding any remaining slots with fill_with unless it is false.\n\n[in_groups_of(list, number, fill_with \\\\ nil)](#in_groups_of/3)\n\nSplits or iterates over the list in groups of size number, padding any remaining slots with fill_with unless it is +false+.\n\n[second(list)](#second/1)\n\nEqual to `Enum.at(list, 1)`.\n\n[second_to_last(list)](#second_to_last/1)\n\nEqual to `Enum.at(list, -2)`.\n\n[third(list)](#third/1)\n\nEqual to `Enum.at(list, 2)`.\n\n[third_to_last(list)](#third_to_last/1)\n\nEqual to `Enum.at(list, -3)`.\n\n[to(list, position)](#to/2)\n\nReturns the beginning of the list up to position.\n\n[to_default_s(list)](#to_default_s/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[to_sentence(list, opts \\\\ [])](#to_sentence/2)\n\nConverts the list to a comma-separated sentence where the last element is joined by the connector word.\n\n[Link to this section](#functions)\nFunctions\n===\n\nRList.Native\n===\n\nA module defines all of native List functions when `use RList.Native`.\n[See also.](https://hexdocs.pm/elixir/List.html)\n\nRList.Ruby\n===\n\nSummarized all of Ruby's Array functions.\nFunctions corresponding to the following patterns are not implemented\n\n* When a function with the same name already exists in Elixir.\n* When a method name includes `!`.\n* &, *, +, -, <<, <=>, ==, [], []=.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Types](#types)\n---\n\n[type_enumerable()](#t:type_enumerable/0)\n\n[type_pattern()](#t:type_pattern/0)\n\n[Functions](#functions)\n---\n\n[all_combination(list, length)](#all_combination/2)\n\nSee [`RList.Ruby.repeated_combination/2`](#repeated_combination/2).\n\n[all_combination(list, length, func)](#all_combination/3)\n\nSee [`RList.Ruby.repeated_combination/3`](#repeated_combination/3).\n\n[append(list, elements)](#append/2)\n\nSee [`RList.Ruby.push/2`](#push/2).\n\n[assoc(list, key)](#assoc/2)\n\nReturns the first element in list that is an List whose first key == obj\n\n[clear(list)](#clear/1)\n\nReturns [].\n\n[combination(list, length)](#combination/2)\n\nReturns Stream that is each repeated combinations of elements of given list. The order of combinations is indeterminate.\n\n[combination(list, n, func)](#combination/3)\n\nCalls the function with combinations of elements of given list; returns :ok. The order of combinations is indeterminate.\n\n[delete_if(list, func)](#delete_if/2)\n\nSee [`Enum.reject/2`](https://hexdocs.pm/elixir/Enum.html#reject/2).\n\n[difference(list1, list2)](#difference/2)\n\nReturns differences between list1 and list2.\n\n[dig(list, index, identifiers \\\\ [])](#dig/3)\n\nFinds and returns the element in nested elements that is specified by index and identifiers.\n\n[each_index(list, func)](#each_index/2)\n\nSee [`Enum.with_index/2`](https://hexdocs.pm/elixir/Enum.html#with_index/2).\n\n[eql?(list1, list2)](#eql?/2)\n\nReturns true if list1 == list2.\n\n[fill(list, filler_fun)](#fill/2)\n\nFills the list with the provided value. The filler can be either a function or a fixed value.\n\n[fill(list, filler_fun, fill_range)](#fill/3)\n\n[index(list, func_or_pattern)](#index/2)\n\nReturns the index of a specified element.\n\n[insert(list, index, element)](#insert/3)\n\nSee [`List.insert_at/3`](https://hexdocs.pm/elixir/List.html#insert_at/3).\n\n[inspect(list)](#inspect/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[intersect?(list1, list2)](#intersect?/2)\n\nReturns true if the list1 and list2 have at least one element in common, otherwise returns false.\n\n[intersection(list1, list2)](#intersection/2)\n\nReturns a new list containing each element found both in list1 and in all of the given list2; duplicates are omitted.\n\n[keep_if(list, func)](#keep_if/2)\n\nSee [`Enum.filter/2`](https://hexdocs.pm/elixir/Enum.html#filter/2).\n\n[length(list)](#length/1)\n\nSee [`Enum.count/1`](https://hexdocs.pm/elixir/Enum.html#count/1).\n\n[permutation(list, length \\\\ nil)](#permutation/2)\n\nReturns Stream that is each repeated permutations of elements of given list. The order of permutations is indeterminate.\n\n[pop(list, count \\\\ 1)](#pop/2)\n\nSplits the list into the last n elements and the rest. Returns nil if the list is empty.\n\n[prepend(list, count \\\\ 1)](#prepend/2)\n\nSee [`RList.Ruby.shift/2`](#shift/2).\n\n[push(list, elements_or_element)](#push/2)\n\nAppends trailing elements.\n\n[rassoc(list, key)](#rassoc/2)\n\nReturns the first element that is a List whose last element `==` the specified term.\n\n[repeated_combination(list, length)](#repeated_combination/2)\n\nReturns Stream that is each repeated combinations of elements of given list. The order of combinations is indeterminate.\n\n[repeated_combination(list, n, func)](#repeated_combination/3)\n\nCalls the function with each repeated combinations of elements of given list; returns :ok. The order of combinations is indeterminate.\n\n[repeated_permutation(list, length)](#repeated_permutation/2)\n\nReturns Stream that is each repeated permutations of elements of given list. The order of permutations is indeterminate.\n\n[rindex(list, finder)](#rindex/2)\n\nReturns the index of the last element found in in the list. Returns nil if no match is found.\n\n[rotate(list, count \\\\ 1)](#rotate/2)\n\nRotate the list so that the element at count is the first element of the list.\n\n[sample(list, n \\\\ 1)](#sample/2)\n\nReturns one or more random elements.\n\n[shift(list, count \\\\ 1)](#shift/2)\n\nSplits the list into the first n elements and the rest. Returns nil if the list is empty.\n\n[size(list)](#size/1)\n\nSee [`Enum.count/1`](https://hexdocs.pm/elixir/Enum.html#count/1).\n\n[to_ary(list)](#to_ary/1)\n\nReturns list.\n\n[to_s(list)](#to_s/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[transpose(list_of_lists)](#transpose/1)\n\nSee [`List.zip/1`](https://hexdocs.pm/elixir/List.html#zip/1).\n\n[union(list_a, list_b)](#union/2)\n\nReturns a new list by joining two lists, excluding any duplicates and preserving the order from the given lists.\n\n[unshift(list, prepend)](#unshift/2)\n\nPrepends elements to the front of the list, moving other elements upwards.\n\n[values_at(list, indices)](#values_at/2)\n\nReturns a list containing the elements in list corresponding to the given selector(s).\nThe selectors may be either integer indices or ranges.\n\n[Link to this section](#types)\nTypes\n===\n\n[Link to this section](#functions)\nFunctions\n===\n\nRList.Support\n===\n\nSummarized other useful functions related to Lit.\nDefines all of here functions when `use RList.Support`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Types](#types)\n---\n\n[type_enumerable()](#t:type_enumerable/0)\n\n[Functions](#functions)\n---\n\n[new(el)](#new/1)\n\nEqual to `[el]`.\n\n[new(el, amount)](#new/2)\n\nMake a list of size amount.\n\n[Link to this section](#types)\nTypes\n===\n\n[Link to this section](#functions)\nFunctions\n===\n\nRMap\n===\n\nEntry point of Map extensions, and can use all of RMap.* and REnum functions.\nSee also.\n\n* [RMap.Native](https://hexdocs.pm/r_enum/RMap.Native.html#content)\n* [RMap.Ruby](https://hexdocs.pm/r_enum/RMap.Ruby.html#content)\n* [RMap.ActiveSupport](https://hexdocs.pm/r_enum/RMap.ActiveSupport.html#content)\n* [RMap.Support](https://hexdocs.pm/r_enum/RMap.Support.html#content)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html#content)\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[all?(arg1)](#all?/1)\n\nSee [`REnum.all?/1`](REnum.html#all?/1).\n\n[all?(arg1, arg2)](#all?/2)\n\nSee [`REnum.all?/2`](REnum.html#all?/2).\n\n[any?(arg1)](#any?/1)\n\nSee [`REnum.any?/1`](REnum.html#any?/1).\n\n[any?(arg1, arg2)](#any?/2)\n\nSee [`REnum.any?/2`](REnum.html#any?/2).\n\n[assert_valid_keys(arg1, arg2)](#assert_valid_keys/2)\n\nSee [`RMap.ActiveSupport.assert_valid_keys/2`](RMap.ActiveSupport.html#assert_valid_keys/2).\n\n[assoc(arg1, arg2)](#assoc/2)\n\nSee [`RMap.Ruby.assoc/2`](RMap.Ruby.html#assoc/2).\n\n[at(arg1, arg2)](#at/2)\n\nSee [`REnum.at/2`](REnum.html#at/2).\n\n[at(arg1, arg2, arg3)](#at/3)\n\nSee [`REnum.at/3`](REnum.html#at/3).\n\n[atomize_keys(arg1)](#atomize_keys/1)\n\nSee [`RMap.ActiveSupport.atomize_keys/1`](RMap.ActiveSupport.html#atomize_keys/1).\n\n[chain(arg1)](#chain/1)\n\nSee [`REnum.chain/1`](REnum.html#chain/1).\n\n[chain(arg1, arg2)](#chain/2)\n\nSee [`REnum.chain/2`](REnum.html#chain/2).\n\n[chunk_by(arg1, arg2)](#chunk_by/2)\n\nSee [`REnum.chunk_by/2`](REnum.html#chunk_by/2).\n\n[chunk_every(arg1, arg2)](#chunk_every/2)\n\nSee [`REnum.chunk_every/2`](REnum.html#chunk_every/2).\n\n[chunk_every(arg1, arg2, arg3)](#chunk_every/3)\n\nSee [`REnum.chunk_every/3`](REnum.html#chunk_every/3).\n\n[chunk_every(arg1, arg2, arg3, arg4)](#chunk_every/4)\n\nSee [`REnum.chunk_every/4`](REnum.html#chunk_every/4).\n\n[chunk_while(arg1, arg2, arg3, arg4)](#chunk_while/4)\n\nSee [`REnum.chunk_while/4`](REnum.html#chunk_while/4).\n\n[clear(arg1)](#clear/1)\n\nSee [`RMap.Ruby.clear/1`](RMap.Ruby.html#clear/1).\n\n[collect(arg1, arg2)](#collect/2)\n\nSee [`REnum.collect/2`](REnum.html#collect/2).\n\n[collect_concat(arg1, arg2)](#collect_concat/2)\n\nSee [`REnum.collect_concat/2`](REnum.html#collect_concat/2).\n\n[compact(arg1)](#compact/1)\n\nSee [`REnum.compact/1`](REnum.html#compact/1).\n\n[compact_blank(arg1)](#compact_blank/1)\n\nSee [`REnum.compact_blank/1`](REnum.html#compact_blank/1).\n\n[concat(arg1)](#concat/1)\n\nSee [`REnum.concat/1`](REnum.html#concat/1).\n\n[concat(arg1, arg2)](#concat/2)\n\nSee [`REnum.concat/2`](REnum.html#concat/2).\n\n[count(arg1)](#count/1)\n\nSee [`REnum.count/1`](REnum.html#count/1).\n\n[count(arg1, arg2)](#count/2)\n\nSee [`REnum.count/2`](REnum.html#count/2).\n\n[count_until(arg1, arg2)](#count_until/2)\n\nSee [`REnum.count_until/2`](REnum.html#count_until/2).\n\n[count_until(arg1, arg2, arg3)](#count_until/3)\n\nSee [`REnum.count_until/3`](REnum.html#count_until/3).\n\n[cycle(arg1, arg2, arg3)](#cycle/3)\n\nSee [`REnum.cycle/3`](REnum.html#cycle/3).\n\n[dedup(arg1)](#dedup/1)\n\nSee [`REnum.dedup/1`](REnum.html#dedup/1).\n\n[dedup_by(arg1, arg2)](#dedup_by/2)\n\nSee [`REnum.dedup_by/2`](REnum.html#dedup_by/2).\n\n[deep_atomize_keys(arg1)](#deep_atomize_keys/1)\n\nSee [`RMap.ActiveSupport.deep_atomize_keys/1`](RMap.ActiveSupport.html#deep_atomize_keys/1).\n\n[deep_stringify_keys(arg1)](#deep_stringify_keys/1)\n\nSee [`RMap.ActiveSupport.deep_stringify_keys/1`](RMap.ActiveSupport.html#deep_stringify_keys/1).\n\n[deep_symbolize_keys(arg1)](#deep_symbolize_keys/1)\n\nSee [`RMap.ActiveSupport.deep_symbolize_keys/1`](RMap.ActiveSupport.html#deep_symbolize_keys/1).\n\n[deep_to_list(arg1)](#deep_to_list/1)\n\nSee [`RMap.Support.deep_to_list/1`](RMap.Support.html#deep_to_list/1).\n\n[deep_transform_keys(arg1, arg2)](#deep_transform_keys/2)\n\nSee [`RMap.ActiveSupport.deep_transform_keys/2`](RMap.ActiveSupport.html#deep_transform_keys/2).\n\n[deep_transform_values(arg1, arg2)](#deep_transform_values/2)\n\nSee [`RMap.ActiveSupport.deep_transform_values/2`](RMap.ActiveSupport.html#deep_transform_values/2).\n\n[delete(arg1, arg2)](#delete/2)\n\nSee [`Map.delete/2`](https://hexdocs.pm/elixir/Map.html#delete/2).\n\n[delete_if(arg1, arg2)](#delete_if/2)\n\nSee [`RMap.Ruby.delete_if/2`](RMap.Ruby.html#delete_if/2).\n\n[detect(arg1, arg2)](#detect/2)\n\nSee [`REnum.detect/2`](REnum.html#detect/2).\n\n[detect(arg1, arg2, arg3)](#detect/3)\n\nSee [`REnum.detect/3`](REnum.html#detect/3).\n\n[dig(arg1, arg2)](#dig/2)\n\nSee [`RMap.Ruby.dig/2`](RMap.Ruby.html#dig/2).\n\n[drop(arg1, arg2)](#drop/2)\n\nSee [`Map.drop/2`](https://hexdocs.pm/elixir/Map.html#drop/2).\n\n[drop_every(arg1, arg2)](#drop_every/2)\n\nSee [`REnum.drop_every/2`](REnum.html#drop_every/2).\n\n[drop_while(arg1, arg2)](#drop_while/2)\n\nSee [`REnum.drop_while/2`](REnum.html#drop_while/2).\n\n[each(arg1, arg2)](#each/2)\n\nSee [`REnum.each/2`](REnum.html#each/2).\n\n[each_cons(arg1, arg2, arg3)](#each_cons/3)\n\nSee [`REnum.each_cons/3`](REnum.html#each_cons/3).\n\n[each_entry(arg1, arg2)](#each_entry/2)\n\nSee [`REnum.each_entry/2`](REnum.html#each_entry/2).\n\n[each_key(arg1, arg2)](#each_key/2)\n\nSee [`RMap.Ruby.each_key/2`](RMap.Ruby.html#each_key/2).\n\n[each_pair(arg1, arg2)](#each_pair/2)\n\nSee [`RMap.Ruby.each_pair/2`](RMap.Ruby.html#each_pair/2).\n\n[each_slice(arg1, arg2)](#each_slice/2)\n\nSee [`REnum.each_slice/2`](REnum.html#each_slice/2).\n\n[each_slice(arg1, arg2, arg3)](#each_slice/3)\n\nSee [`REnum.each_slice/3`](REnum.html#each_slice/3).\n\n[each_value(arg1, arg2)](#each_value/2)\n\nSee [`RMap.Ruby.each_value/2`](RMap.Ruby.html#each_value/2).\n\n[each_with_index(arg1)](#each_with_index/1)\n\nSee [`REnum.each_with_index/1`](REnum.html#each_with_index/1).\n\n[each_with_index(arg1, arg2)](#each_with_index/2)\n\nSee [`REnum.each_with_index/2`](REnum.html#each_with_index/2).\n\n[each_with_object(arg1, arg2, arg3)](#each_with_object/3)\n\nSee [`REnum.each_with_object/3`](REnum.html#each_with_object/3).\n\n[empty?(arg1)](#empty?/1)\n\nSee [`REnum.empty?/1`](REnum.html#empty?/1).\n\n[entries(arg1)](#entries/1)\n\nSee [`REnum.entries/1`](REnum.html#entries/1).\n\n[eql?(arg1, arg2)](#eql?/2)\n\nSee [`RMap.Ruby.eql?/2`](RMap.Ruby.html#eql?/2).\n\n[equal?(arg1, arg2)](#equal?/2)\n\nSee [`Map.equal?/2`](https://hexdocs.pm/elixir/Map.html#equal?/2).\n\n[except(arg1, arg2)](#except/2)\n\nSee [`RMap.Ruby.except/2`](RMap.Ruby.html#except/2).\n\n[exclude?(arg1, arg2)](#exclude?/2)\n\nSee [`REnum.exclude?/2`](REnum.html#exclude?/2).\n\n[excluding(arg1, arg2)](#excluding/2)\n\nSee [`REnum.excluding/2`](REnum.html#excluding/2).\n\n[fetch(arg1, arg2)](#fetch/2)\n\nSee [`Map.fetch/2`](https://hexdocs.pm/elixir/Map.html#fetch/2).\n\n[fetch!(arg1, arg2)](#fetch!/2)\n\nSee [`Map.fetch!/2`](https://hexdocs.pm/elixir/Map.html#fetch!/2).\n\n[fetch_values(arg1, arg2)](#fetch_values/2)\n\nSee [`RMap.Ruby.fetch_values/2`](RMap.Ruby.html#fetch_values/2).\n\n[fetch_values(arg1, arg2, arg3)](#fetch_values/3)\n\nSee [`RMap.Ruby.fetch_values/3`](RMap.Ruby.html#fetch_values/3).\n\n[filter(arg1, arg2)](#filter/2)\n\nSee [`RMap.Ruby.filter/2`](RMap.Ruby.html#filter/2).\n\n[find(arg1, arg2)](#find/2)\n\nSee [`REnum.find/2`](REnum.html#find/2).\n\n[find(arg1, arg2, arg3)](#find/3)\n\nSee [`REnum.find/3`](REnum.html#find/3).\n\n[find_all(arg1, arg2)](#find_all/2)\n\nSee [`REnum.find_all/2`](REnum.html#find_all/2).\n\n[find_index(arg1, arg2)](#find_index/2)\n\nSee [`REnum.find_index/2`](REnum.html#find_index/2).\n\n[find_index_with_index(arg1, arg2)](#find_index_with_index/2)\n\nSee [`REnum.find_index_with_index/2`](REnum.html#find_index_with_index/2).\n\n[find_value(arg1, arg2)](#find_value/2)\n\nSee [`REnum.find_value/2`](REnum.html#find_value/2).\n\n[find_value(arg1, arg2, arg3)](#find_value/3)\n\nSee [`REnum.find_value/3`](REnum.html#find_value/3).\n\n[first(arg1)](#first/1)\n\nSee [`REnum.first/1`](REnum.html#first/1).\n\n[first(arg1, arg2)](#first/2)\n\nSee [`REnum.first/2`](REnum.html#first/2).\n\n[flat_map(arg1, arg2)](#flat_map/2)\n\nSee [`REnum.flat_map/2`](REnum.html#flat_map/2).\n\n[flat_map_reduce(arg1, arg2, arg3)](#flat_map_reduce/3)\n\nSee [`REnum.flat_map_reduce/3`](REnum.html#flat_map_reduce/3).\n\n[flatten(arg1)](#flatten/1)\n\nSee [`RMap.Ruby.flatten/1`](RMap.Ruby.html#flatten/1).\n\n[frequencies(arg1)](#frequencies/1)\n\nSee [`REnum.frequencies/1`](REnum.html#frequencies/1).\n\n[frequencies_by(arg1, arg2)](#frequencies_by/2)\n\nSee [`REnum.frequencies_by/2`](REnum.html#frequencies_by/2).\n\n[from_struct(arg1)](#from_struct/1)\n\nSee [`Map.from_struct/1`](https://hexdocs.pm/elixir/Map.html#from_struct/1).\n\n[get(arg1, arg2)](#get/2)\n\nSee [`Map.get/2`](https://hexdocs.pm/elixir/Map.html#get/2).\n\n[get(arg1, arg2, arg3)](#get/3)\n\nSee [`Map.get/3`](https://hexdocs.pm/elixir/Map.html#get/3).\n\n[get_and_update(arg1, arg2, arg3)](#get_and_update/3)\n\nSee [`Map.get_and_update/3`](https://hexdocs.pm/elixir/Map.html#get_and_update/3).\n\n[get_and_update!(arg1, arg2, arg3)](#get_and_update!/3)\n\nSee [`Map.get_and_update!/3`](https://hexdocs.pm/elixir/Map.html#get_and_update!/3).\n\n[get_lazy(arg1, arg2, arg3)](#get_lazy/3)\n\nSee [`Map.get_lazy/3`](https://hexdocs.pm/elixir/Map.html#get_lazy/3).\n\n[grep(arg1, arg2)](#grep/2)\n\nSee [`REnum.grep/2`](REnum.html#grep/2).\n\n[grep(arg1, arg2, arg3)](#grep/3)\n\nSee [`REnum.grep/3`](REnum.html#grep/3).\n\n[grep_v(arg1, arg2)](#grep_v/2)\n\nSee [`REnum.grep_v/2`](REnum.html#grep_v/2).\n\n[grep_v(arg1, arg2, arg3)](#grep_v/3)\n\nSee [`REnum.grep_v/3`](REnum.html#grep_v/3).\n\n[group_by(arg1, arg2)](#group_by/2)\n\nSee [`REnum.group_by/2`](REnum.html#group_by/2).\n\n[group_by(arg1, arg2, arg3)](#group_by/3)\n\nSee [`REnum.group_by/3`](REnum.html#group_by/3).\n\n[has_key?(arg1, arg2)](#has_key?/2)\n\nSee [`Map.has_key?/2`](https://hexdocs.pm/elixir/Map.html#has_key?/2).\n\n[has_value?(arg1, arg2)](#has_value?/2)\n\nSee [`RMap.Ruby.has_value?/2`](RMap.Ruby.html#has_value?/2).\n\n[in_order_of(arg1, arg2, arg3)](#in_order_of/3)\n\nSee [`REnum.in_order_of/3`](REnum.html#in_order_of/3).\n\n[include?(arg1, arg2)](#include?/2)\n\nSee [`REnum.include?/2`](REnum.html#include?/2).\n\n[including(arg1, arg2)](#including/2)\n\nSee [`REnum.including/2`](REnum.html#including/2).\n\n[index_by(arg1, arg2)](#index_by/2)\n\nSee [`REnum.index_by/2`](REnum.html#index_by/2).\n\n[index_with(arg1, arg2)](#index_with/2)\n\nSee [`REnum.index_with/2`](REnum.html#index_with/2).\n\n[inject(arg1, arg2)](#inject/2)\n\nSee [`REnum.inject/2`](REnum.html#inject/2).\n\n[inject(arg1, arg2, arg3)](#inject/3)\n\nSee [`REnum.inject/3`](REnum.html#inject/3).\n\n[inspect(arg1)](#inspect/1)\n\nSee [`RMap.Ruby.inspect/1`](RMap.Ruby.html#inspect/1).\n\n[intersperse(arg1, arg2)](#intersperse/2)\n\nSee [`REnum.intersperse/2`](REnum.html#intersperse/2).\n\n[into(arg1, arg2)](#into/2)\n\nSee [`REnum.into/2`](REnum.html#into/2).\n\n[into(arg1, arg2, arg3)](#into/3)\n\nSee [`REnum.into/3`](REnum.html#into/3).\n\n[invert(arg1)](#invert/1)\n\nSee [`RMap.Ruby.invert/1`](RMap.Ruby.html#invert/1).\n\n[join(arg1)](#join/1)\n\nSee [`REnum.join/1`](REnum.html#join/1).\n\n[join(arg1, arg2)](#join/2)\n\nSee [`REnum.join/2`](REnum.html#join/2).\n\n[keep_if(arg1, arg2)](#keep_if/2)\n\nSee [`RMap.Ruby.keep_if/2`](RMap.Ruby.html#keep_if/2).\n\n[key(arg1, arg2)](#key/2)\n\nSee [`RMap.Ruby.key/2`](RMap.Ruby.html#key/2).\n\n[key(arg1, arg2, arg3)](#key/3)\n\nSee [`RMap.Ruby.key/3`](RMap.Ruby.html#key/3).\n\n[key?(arg1, arg2)](#key?/2)\n\nSee [`RMap.Ruby.key?/2`](RMap.Ruby.html#key?/2).\n\n[keys(arg1)](#keys/1)\n\nSee [`Map.keys/1`](https://hexdocs.pm/elixir/Map.html#keys/1).\n\n[lazy(arg1)](#lazy/1)\n\nSee [`REnum.lazy/1`](REnum.html#lazy/1).\n\n[length(arg1)](#length/1)\n\nSee [`RMap.Ruby.length/1`](RMap.Ruby.html#length/1).\n\n[list_and_not_keyword?(arg1)](#list_and_not_keyword?/1)\n\nSee [`REnum.list_and_not_keyword?/1`](REnum.html#list_and_not_keyword?/1).\n\n[many?(arg1)](#many?/1)\n\nSee [`REnum.many?/1`](REnum.html#many?/1).\n\n[many?(arg1, arg2)](#many?/2)\n\nSee [`REnum.many?/2`](REnum.html#many?/2).\n\n[map_and_not_range?(arg1)](#map_and_not_range?/1)\n\nSee [`REnum.map_and_not_range?/1`](REnum.html#map_and_not_range?/1).\n\n[map_every(arg1, arg2, arg3)](#map_every/3)\n\nSee [`REnum.map_every/3`](REnum.html#map_every/3).\n\n[map_intersperse(arg1, arg2, arg3)](#map_intersperse/3)\n\nSee [`REnum.map_intersperse/3`](REnum.html#map_intersperse/3).\n\n[map_join(arg1, arg2)](#map_join/2)\n\nSee [`REnum.map_join/2`](REnum.html#map_join/2).\n\n[map_join(arg1, arg2, arg3)](#map_join/3)\n\nSee [`REnum.map_join/3`](REnum.html#map_join/3).\n\n[map_reduce(arg1, arg2, arg3)](#map_reduce/3)\n\nSee [`REnum.map_reduce/3`](REnum.html#map_reduce/3).\n\n[match_function(arg1)](#match_function/1)\n\nSee [`REnum.match_function/1`](REnum.html#match_function/1).\n\n[max(arg1)](#max/1)\n\nSee [`REnum.max/1`](REnum.html#max/1).\n\n[max(arg1, arg2)](#max/2)\n\nSee [`REnum.max/2`](REnum.html#max/2).\n\n[max(arg1, arg2, arg3)](#max/3)\n\nSee [`REnum.max/3`](REnum.html#max/3).\n\n[max_by(arg1, arg2)](#max_by/2)\n\nSee [`REnum.max_by/2`](REnum.html#max_by/2).\n\n[max_by(arg1, arg2, arg3)](#max_by/3)\n\nSee [`REnum.max_by/3`](REnum.html#max_by/3).\n\n[max_by(arg1, arg2, arg3, arg4)](#max_by/4)\n\nSee [`REnum.max_by/4`](REnum.html#max_by/4).\n\n[maximum(arg1, arg2)](#maximum/2)\n\nSee [`REnum.maximum/2`](REnum.html#maximum/2).\n\n[member?(arg1, arg2)](#member?/2)\n\nSee [`REnum.member?/2`](REnum.html#member?/2).\n\n[merge(arg1, arg2)](#merge/2)\n\nSee [`Map.merge/2`](https://hexdocs.pm/elixir/Map.html#merge/2).\n\n[merge(arg1, arg2, arg3)](#merge/3)\n\nSee [`Map.merge/3`](https://hexdocs.pm/elixir/Map.html#merge/3).\n\n[min(arg1)](#min/1)\n\nSee [`REnum.min/1`](REnum.html#min/1).\n\n[min(arg1, arg2)](#min/2)\n\nSee [`REnum.min/2`](REnum.html#min/2).\n\n[min(arg1, arg2, arg3)](#min/3)\n\nSee [`REnum.min/3`](REnum.html#min/3).\n\n[min_by(arg1, arg2)](#min_by/2)\n\nSee [`REnum.min_by/2`](REnum.html#min_by/2).\n\n[min_by(arg1, arg2, arg3)](#min_by/3)\n\nSee [`REnum.min_by/3`](REnum.html#min_by/3).\n\n[min_by(arg1, arg2, arg3, arg4)](#min_by/4)\n\nSee [`REnum.min_by/4`](REnum.html#min_by/4).\n\n[min_max(arg1)](#min_max/1)\n\nSee [`REnum.min_max/1`](REnum.html#min_max/1).\n\n[min_max(arg1, arg2)](#min_max/2)\n\nSee [`REnum.min_max/2`](REnum.html#min_max/2).\n\n[min_max_by(arg1, arg2)](#min_max_by/2)\n\nSee [`REnum.min_max_by/2`](REnum.html#min_max_by/2).\n\n[min_max_by(arg1, arg2, arg3)](#min_max_by/3)\n\nSee [`REnum.min_max_by/3`](REnum.html#min_max_by/3).\n\n[min_max_by(arg1, arg2, arg3, arg4)](#min_max_by/4)\n\nSee [`REnum.min_max_by/4`](REnum.html#min_max_by/4).\n\n[minimum(arg1, arg2)](#minimum/2)\n\nSee [`REnum.minimum/2`](REnum.html#minimum/2).\n\n[minmax(arg1)](#minmax/1)\n\nSee [`REnum.minmax/1`](REnum.html#minmax/1).\n\n[minmax(arg1, arg2)](#minmax/2)\n\nSee [`REnum.minmax/2`](REnum.html#minmax/2).\n\n[minmax_by(arg1, arg2)](#minmax_by/2)\n\nSee [`REnum.minmax_by/2`](REnum.html#minmax_by/2).\n\n[minmax_by(arg1, arg2, arg3)](#minmax_by/3)\n\nSee [`REnum.minmax_by/3`](REnum.html#minmax_by/3).\n\n[minmax_by(arg1, arg2, arg3, arg4)](#minmax_by/4)\n\nSee [`REnum.minmax_by/4`](REnum.html#minmax_by/4).\n\n[new()](#new/0)\n\nSee [`Map.new/0`](https://hexdocs.pm/elixir/Map.html#new/0).\n\n[new(arg1)](#new/1)\n\nSee [`Map.new/1`](https://hexdocs.pm/elixir/Map.html#new/1).\n\n[new(arg1, arg2)](#new/2)\n\nSee [`Map.new/2`](https://hexdocs.pm/elixir/Map.html#new/2).\n\n[none?(arg1)](#none?/1)\n\nSee [`REnum.none?/1`](REnum.html#none?/1).\n\n[none?(arg1, arg2)](#none?/2)\n\nSee [`REnum.none?/2`](REnum.html#none?/2).\n\n[one?(arg1)](#one?/1)\n\nSee [`REnum.one?/1`](REnum.html#one?/1).\n\n[one?(arg1, arg2)](#one?/2)\n\nSee [`REnum.one?/2`](REnum.html#one?/2).\n\n[pick(arg1, arg2)](#pick/2)\n\nSee [`REnum.pick/2`](REnum.html#pick/2).\n\n[pluck(arg1, arg2)](#pluck/2)\n\nSee [`REnum.pluck/2`](REnum.html#pluck/2).\n\n[pop(arg1, arg2)](#pop/2)\n\nSee [`Map.pop/2`](https://hexdocs.pm/elixir/Map.html#pop/2).\n\n[pop(arg1, arg2, arg3)](#pop/3)\n\nSee [`Map.pop/3`](https://hexdocs.pm/elixir/Map.html#pop/3).\n\n[pop!(arg1, arg2)](#pop!/2)\n\nSee [`Map.pop!/2`](https://hexdocs.pm/elixir/Map.html#pop!/2).\n\n[pop_lazy(arg1, arg2, arg3)](#pop_lazy/3)\n\nSee [`Map.pop_lazy/3`](https://hexdocs.pm/elixir/Map.html#pop_lazy/3).\n\n[product(arg1)](#product/1)\n\nSee [`REnum.product/1`](REnum.html#product/1).\n\n[put(arg1, arg2, arg3)](#put/3)\n\nSee [`Map.put/3`](https://hexdocs.pm/elixir/Map.html#put/3).\n\n[put_new(arg1, arg2, arg3)](#put_new/3)\n\nSee [`Map.put_new/3`](https://hexdocs.pm/elixir/Map.html#put_new/3).\n\n[put_new_lazy(arg1, arg2, arg3)](#put_new_lazy/3)\n\nSee [`Map.put_new_lazy/3`](https://hexdocs.pm/elixir/Map.html#put_new_lazy/3).\n\n[random(arg1)](#random/1)\n\nSee [`REnum.random/1`](REnum.html#random/1).\n\n[range?(arg1)](#range?/1)\n\nSee [`REnum.range?/1`](REnum.html#range?/1).\n\n[rassoc(arg1, arg2)](#rassoc/2)\n\nSee [`RMap.Ruby.rassoc/2`](RMap.Ruby.html#rassoc/2).\n\n[reduce(arg1, arg2)](#reduce/2)\n\nSee [`REnum.reduce/2`](REnum.html#reduce/2).\n\n[reduce(arg1, arg2, arg3)](#reduce/3)\n\nSee [`REnum.reduce/3`](REnum.html#reduce/3).\n\n[reduce_while(arg1, arg2, arg3)](#reduce_while/3)\n\nSee [`REnum.reduce_while/3`](REnum.html#reduce_while/3).\n\n[reject(arg1, arg2)](#reject/2)\n\nSee [`RMap.Ruby.reject/2`](RMap.Ruby.html#reject/2).\n\n[replace(arg1, arg2, arg3)](#replace/3)\n\nSee [`Map.replace/3`](https://hexdocs.pm/elixir/Map.html#replace/3).\n\n[replace!(arg1, arg2, arg3)](#replace!/3)\n\nSee [`Map.replace!/3`](https://hexdocs.pm/elixir/Map.html#replace!/3).\n\n[reverse(arg1)](#reverse/1)\n\nSee [`REnum.reverse/1`](REnum.html#reverse/1).\n\n[reverse(arg1, arg2)](#reverse/2)\n\nSee [`REnum.reverse/2`](REnum.html#reverse/2).\n\n[reverse_each(arg1, arg2)](#reverse_each/2)\n\nSee [`REnum.reverse_each/2`](REnum.html#reverse_each/2).\n\n[reverse_slice(arg1, arg2, arg3)](#reverse_slice/3)\n\nSee [`REnum.reverse_slice/3`](REnum.html#reverse_slice/3).\n\n[scan(arg1, arg2)](#scan/2)\n\nSee [`REnum.scan/2`](REnum.html#scan/2).\n\n[scan(arg1, arg2, arg3)](#scan/3)\n\nSee [`REnum.scan/3`](REnum.html#scan/3).\n\n[select(arg1, arg2)](#select/2)\n\nSee [`RMap.Ruby.select/2`](RMap.Ruby.html#select/2).\n\n[shift(arg1)](#shift/1)\n\nSee [`RMap.Ruby.shift/1`](RMap.Ruby.html#shift/1).\n\n[shuffle(arg1)](#shuffle/1)\n\nSee [`REnum.shuffle/1`](REnum.html#shuffle/1).\n\n[size(arg1)](#size/1)\n\nSee [`RMap.Ruby.size/1`](RMap.Ruby.html#size/1).\n\n[slice(arg1, arg2)](#slice/2)\n\nSee [`REnum.slice/2`](REnum.html#slice/2).\n\n[slice(arg1, arg2, arg3)](#slice/3)\n\nSee [`REnum.slice/3`](REnum.html#slice/3).\n\n[slice_after(arg1, arg2)](#slice_after/2)\n\nSee [`REnum.slice_after/2`](REnum.html#slice_after/2).\n\n[slice_before(arg1, arg2)](#slice_before/2)\n\nSee [`REnum.slice_before/2`](REnum.html#slice_before/2).\n\n[slice_when(arg1, arg2)](#slice_when/2)\n\nSee [`REnum.slice_when/2`](REnum.html#slice_when/2).\n\n[slide(arg1, arg2, arg3)](#slide/3)\n\nSee [`REnum.slide/3`](REnum.html#slide/3).\n\n[sole(arg1)](#sole/1)\n\nSee [`REnum.sole/1`](REnum.html#sole/1).\n\n[sort(arg1)](#sort/1)\n\nSee [`REnum.sort/1`](REnum.html#sort/1).\n\n[sort(arg1, arg2)](#sort/2)\n\nSee [`REnum.sort/2`](REnum.html#sort/2).\n\n[sort_by(arg1, arg2)](#sort_by/2)\n\nSee [`REnum.sort_by/2`](REnum.html#sort_by/2).\n\n[sort_by(arg1, arg2, arg3)](#sort_by/3)\n\nSee [`REnum.sort_by/3`](REnum.html#sort_by/3).\n\n[split(arg1, arg2)](#split/2)\n\nSee [`Map.split/2`](https://hexdocs.pm/elixir/Map.html#split/2).\n\n[split_while(arg1, arg2)](#split_while/2)\n\nSee [`REnum.split_while/2`](REnum.html#split_while/2).\n\n[split_with(arg1, arg2)](#split_with/2)\n\nSee [`REnum.split_with/2`](REnum.html#split_with/2).\n\n[store(arg1, arg2, arg3)](#store/3)\n\nSee [`RMap.Ruby.store/3`](RMap.Ruby.html#store/3).\n\n[stringify_keys(arg1)](#stringify_keys/1)\n\nSee [`RMap.ActiveSupport.stringify_keys/1`](RMap.ActiveSupport.html#stringify_keys/1).\n\n[sum(arg1)](#sum/1)\n\nSee [`REnum.sum/1`](REnum.html#sum/1).\n\n[symbolize_keys(arg1)](#symbolize_keys/1)\n\nSee [`RMap.ActiveSupport.symbolize_keys/1`](RMap.ActiveSupport.html#symbolize_keys/1).\n\n[take(arg1, arg2)](#take/2)\n\nSee [`Map.take/2`](https://hexdocs.pm/elixir/Map.html#take/2).\n\n[take_every(arg1, arg2)](#take_every/2)\n\nSee [`REnum.take_every/2`](REnum.html#take_every/2).\n\n[take_random(arg1, arg2)](#take_random/2)\n\nSee [`REnum.take_random/2`](REnum.html#take_random/2).\n\n[take_while(arg1, arg2)](#take_while/2)\n\nSee [`REnum.take_while/2`](REnum.html#take_while/2).\n\n[tally(arg1)](#tally/1)\n\nSee [`REnum.tally/1`](REnum.html#tally/1).\n\n[to_a(arg1)](#to_a/1)\n\nSee [`REnum.to_a/1`](REnum.html#to_a/1).\n\n[to_h(arg1)](#to_h/1)\n\nSee [`REnum.to_h/1`](REnum.html#to_h/1).\n\n[to_h(arg1, arg2)](#to_h/2)\n\nSee [`REnum.to_h/2`](REnum.html#to_h/2).\n\n[to_hash(arg1)](#to_hash/1)\n\nSee [`RMap.Ruby.to_hash/1`](RMap.Ruby.html#to_hash/1).\n\n[to_l(arg1)](#to_l/1)\n\nSee [`REnum.to_l/1`](REnum.html#to_l/1).\n\n[to_list(arg1)](#to_list/1)\n\nSee [`Map.to_list/1`](https://hexdocs.pm/elixir/Map.html#to_list/1).\n\n[to_s(arg1)](#to_s/1)\n\nSee [`RMap.Ruby.to_s/1`](RMap.Ruby.html#to_s/1).\n\n[transform_keys(arg1, arg2)](#transform_keys/2)\n\nSee [`RMap.Ruby.transform_keys/2`](RMap.Ruby.html#transform_keys/2).\n\n[transform_values(arg1, arg2)](#transform_values/2)\n\nSee [`RMap.Ruby.transform_values/2`](RMap.Ruby.html#transform_values/2).\n\n[truthy_count(arg1)](#truthy_count/1)\n\nSee [`REnum.truthy_count/1`](REnum.html#truthy_count/1).\n\n[truthy_count(arg1, arg2)](#truthy_count/2)\n\nSee [`REnum.truthy_count/2`](REnum.html#truthy_count/2).\n\n[uniq_by(arg1, arg2)](#uniq_by/2)\n\nSee [`REnum.uniq_by/2`](REnum.html#uniq_by/2).\n\n[unzip(arg1)](#unzip/1)\n\nSee [`REnum.unzip/1`](REnum.html#unzip/1).\n\n[update(arg1, arg2, arg3, arg4)](#update/4)\n\nSee [`Map.update/4`](https://hexdocs.pm/elixir/Map.html#update/4).\n\n[update!(arg1, arg2, arg3)](#update!/3)\n\nSee [`Map.update!/3`](https://hexdocs.pm/elixir/Map.html#update!/3).\n\n[value?(arg1, arg2)](#value?/2)\n\nSee [`RMap.Ruby.value?/2`](RMap.Ruby.html#value?/2).\n\n[values(arg1)](#values/1)\n\nSee [`Map.values/1`](https://hexdocs.pm/elixir/Map.html#values/1).\n\n[values_at(arg1, arg2)](#values_at/2)\n\nSee [`RMap.Ruby.values_at/2`](RMap.Ruby.html#values_at/2).\n\n[with_index(arg1)](#with_index/1)\n\nSee [`REnum.with_index/1`](REnum.html#with_index/1).\n\n[with_index(arg1, arg2)](#with_index/2)\n\nSee [`REnum.with_index/2`](REnum.html#with_index/2).\n\n[without(arg1, arg2)](#without/2)\n\nSee [`REnum.without/2`](REnum.html#without/2).\n\n[zip(arg1)](#zip/1)\n\nSee [`REnum.zip/1`](REnum.html#zip/1).\n\n[zip(arg1, arg2)](#zip/2)\n\nSee [`REnum.zip/2`](REnum.html#zip/2).\n\n[zip_reduce(arg1, arg2, arg3)](#zip_reduce/3)\n\nSee [`REnum.zip_reduce/3`](REnum.html#zip_reduce/3).\n\n[zip_reduce(arg1, arg2, arg3, arg4)](#zip_reduce/4)\n\nSee [`REnum.zip_reduce/4`](REnum.html#zip_reduce/4).\n\n[zip_with(arg1, arg2)](#zip_with/2)\n\nSee [`REnum.zip_with/2`](REnum.html#zip_with/2).\n\n[zip_with(arg1, arg2, arg3)](#zip_with/3)\n\nSee [`REnum.zip_with/3`](REnum.html#zip_with/3).\n\n[Link to this section](#functions)\nFunctions\n===\n\nRMap.ActiveSupport\n===\n\nSummarized all of Hash functions in Rails.ActiveSupport.\nIf a function with the same name already exists in Elixir, that is not implemented.\nDefines all of here functions when `use RMap.ActiveSupport`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[assert_valid_keys(map, keys)](#assert_valid_keys/2)\n\nValidates all keys in a map match given keys, raising ArgumentError on a mismatch.\n\n[atomize_keys(map)](#atomize_keys/1)\n\nSee [`RMap.ActiveSupport.symbolize_keys/1`](#symbolize_keys/1).\n\n[deep_atomize_keys(map)](#deep_atomize_keys/1)\n\nSee [`RMap.ActiveSupport.deep_symbolize_keys/1`](#deep_symbolize_keys/1).\n\n[deep_stringify_keys(map)](#deep_stringify_keys/1)\n\nReturns a list with all keys converted to strings.\nThis includes the keys from the root map and from all nested maps and arrays.\n\n[deep_symbolize_keys(map)](#deep_symbolize_keys/1)\n\nReturns a list with all keys converted to atom.\nThis includes the keys from the root map and from all nested maps and arrays.\n\n[deep_transform_keys(map, func)](#deep_transform_keys/2)\n\nReturns a map with all keys converted by the function.\nThis includes the keys from the root map and from all nested maps and arrays.\n\n[deep_transform_values(map, func)](#deep_transform_values/2)\n\nReturns a map with all values converted by the function.\nThis includes the keys from the root map and from all nested maps and arrays.\n\n[stringify_keys(map)](#stringify_keys/1)\n\nReturns a map with all keys converted to strings.\n\n[symbolize_keys(map)](#symbolize_keys/1)\n\nReturns a map with all keys converted to atom.\n\n[Link to this section](#functions)\nFunctions\n===\n\nRMap.Native\n===\n\nA module defines all of native Map functions when `use RMap.Native`.\n[See also.](https://hexdocs.pm/elixir/Map.html)\n\nRMap.Ruby\n===\n\nSummarized all of Ruby's Hash functions.\nFunctions corresponding to the following patterns are not implemented\n\n* When a function with the same name already exists in Elixir.\n* When a method name includes `!`.\n* <, <=, ==, >, >=, [], []=, default_*\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[assoc(map, key)](#assoc/2)\n\nReturns a 2-element tuple containing a given key and its value.\n\n[clear(_)](#clear/1)\n\nReturns %{}.\n\n[delete_if(map, func)](#delete_if/2)\n\nSee [`RMap.Ruby.reject/2`](#reject/2).\n\n[dig(result, keys)](#dig/2)\n\nReturns the object in nested map that is specified by a given key and additional arguments.\n\n[each_key(map, func)](#each_key/2)\n\nCalls the function with each key; returns :ok.\n\n[each_pair(map, func)](#each_pair/2)\n\nSee [`Enum.each/2`](https://hexdocs.pm/elixir/Enum.html#each/2).\n\n[each_value(map, func)](#each_value/2)\n\nCalls the function with each value; returns :ok.\n\n[eql?(map1, map2)](#eql?/2)\n\nSee [`Map.equal?/2`](https://hexdocs.pm/elixir/Map.html#equal?/2).\n\n[except(map, keys)](#except/2)\n\nReturns a map excluding entries for the given keys.\n\n[fetch_values(map, keys)](#fetch_values/2)\n\nReturns a list containing the values associated with the given keys.\n\n[fetch_values(map, keys, func)](#fetch_values/3)\n\nWhen a function is given, calls the function with each missing key, treating the block's return value as the value for that key.\n\n[filter(map, func)](#filter/2)\n\nReturns a list whose entries are those for which the function returns a truthy value.\n\n[flatten(map)](#flatten/1)\n\nReturns a flatten list.\n\n[has_value?(map, value)](#has_value?/2)\n\nSee [`RMap.Ruby.value?/2`](#value?/2).\n\n[inspect(map)](#inspect/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[invert(map)](#invert/1)\n\nReturns a map object with the each key-value pair inverted.\n\n[keep_if(map, func)](#keep_if/2)\n\nSee [`RMap.Ruby.filter/2`](#filter/2).\n\n[key(map, key, default \\\\ nil)](#key/3)\n\nSee [`Map.get/3`](https://hexdocs.pm/elixir/Map.html#get/3).\n\n[key?(map, key)](#key?/2)\n\nSee [`Map.has_key?/2`](https://hexdocs.pm/elixir/Map.html#has_key?/2).\n\n[length(map)](#length/1)\n\nSee [`Enum.count/1`](https://hexdocs.pm/elixir/Enum.html#count/1).\n\n[rassoc(map, value)](#rassoc/2)\n\nReturns a 2-element tuple consisting of the key and value of the first-found entry having a given value.\n\n[reject(map, func)](#reject/2)\n\nReturns a list whose entries are all those from self for which the function returns false or nil.\n\n[select(map, func)](#select/2)\n\nSee [`RMap.Ruby.filter/2`](#filter/2).\n\n[shift(map)](#shift/1)\n\nRemoves the first map entry; returns a 2-element tuple.\nFirst element is {key, value}.\nSecond element is a map without first pair.\n\n[size(map)](#size/1)\n\nSee [`Enum.count/1`](https://hexdocs.pm/elixir/Enum.html#count/1).\n\n[store(map, key, value)](#store/3)\n\nSee [`Map.put/3`](https://hexdocs.pm/elixir/Map.html#put/3).\n\n[to_hash(map)](#to_hash/1)\n\nReturns given map.\n\n[to_s(map)](#to_s/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[transform_keys(map, func)](#transform_keys/2)\n\nReturns a map with modified keys.\n\n[transform_values(map, func)](#transform_values/2)\n\nReturns a map with modified values.\n\n[value?(map, value)](#value?/2)\n\nReturns true if value is a value in list, otherwise false.\n\n[values_at(map, keys)](#values_at/2)\n\nReturns a list containing values for the given keys.\n\n[Link to this section](#functions)\nFunctions\n===\n\nRMap.Support\n===\n\nSummarized other useful functions related to Lit.\nDefines all of here functions when `use RMap.Support`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[deep_to_list(map)](#deep_to_list/1)\n\nReturns list recursively converted　 from given map to list.\n\n[Link to this section](#functions)\nFunctions\n===\n\nRRange\n===\n\nEntry point of Range extensions, and can use all of RRange.* and REnum functions.\nSee also.\n\n* [RRange.Native](https://hexdocs.pm/r_enum/RRange.Native.html#content)\n* [RRange.Ruby](https://hexdocs.pm/r_enum/RRange.Ruby.html#content)\n* [RRange.ActiveSupport](https://hexdocs.pm/r_enum/RRange.ActiveSupport.html#content)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html#content)\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[all?(arg1)](#all?/1)\n\nSee [`REnum.all?/1`](REnum.html#all?/1).\n\n[all?(arg1, arg2)](#all?/2)\n\nSee [`REnum.all?/2`](REnum.html#all?/2).\n\n[any?(arg1)](#any?/1)\n\nSee [`REnum.any?/1`](REnum.html#any?/1).\n\n[any?(arg1, arg2)](#any?/2)\n\nSee [`REnum.any?/2`](REnum.html#any?/2).\n\n[at(arg1, arg2)](#at/2)\n\nSee [`REnum.at/2`](REnum.html#at/2).\n\n[at(arg1, arg2, arg3)](#at/3)\n\nSee [`REnum.at/3`](REnum.html#at/3).\n\n[begin(arg1)](#begin/1)\n\nSee [`RRange.Ruby.begin/1`](RRange.Ruby.html#begin/1).\n\n[chain(arg1)](#chain/1)\n\nSee [`REnum.chain/1`](REnum.html#chain/1).\n\n[chain(arg1, arg2)](#chain/2)\n\nSee [`REnum.chain/2`](REnum.html#chain/2).\n\n[chunk_by(arg1, arg2)](#chunk_by/2)\n\nSee [`REnum.chunk_by/2`](REnum.html#chunk_by/2).\n\n[chunk_every(arg1, arg2)](#chunk_every/2)\n\nSee [`REnum.chunk_every/2`](REnum.html#chunk_every/2).\n\n[chunk_every(arg1, arg2, arg3)](#chunk_every/3)\n\nSee [`REnum.chunk_every/3`](REnum.html#chunk_every/3).\n\n[chunk_every(arg1, arg2, arg3, arg4)](#chunk_every/4)\n\nSee [`REnum.chunk_every/4`](REnum.html#chunk_every/4).\n\n[chunk_while(arg1, arg2, arg3, arg4)](#chunk_while/4)\n\nSee [`REnum.chunk_while/4`](REnum.html#chunk_while/4).\n\n[collect(arg1, arg2)](#collect/2)\n\nSee [`REnum.collect/2`](REnum.html#collect/2).\n\n[collect_concat(arg1, arg2)](#collect_concat/2)\n\nSee [`REnum.collect_concat/2`](REnum.html#collect_concat/2).\n\n[compact(arg1)](#compact/1)\n\nSee [`REnum.compact/1`](REnum.html#compact/1).\n\n[compact_blank(arg1)](#compact_blank/1)\n\nSee [`REnum.compact_blank/1`](REnum.html#compact_blank/1).\n\n[concat(arg1)](#concat/1)\n\nSee [`REnum.concat/1`](REnum.html#concat/1).\n\n[concat(arg1, arg2)](#concat/2)\n\nSee [`REnum.concat/2`](REnum.html#concat/2).\n\n[count(arg1)](#count/1)\n\nSee [`REnum.count/1`](REnum.html#count/1).\n\n[count(arg1, arg2)](#count/2)\n\nSee [`REnum.count/2`](REnum.html#count/2).\n\n[count_until(arg1, arg2)](#count_until/2)\n\nSee [`REnum.count_until/2`](REnum.html#count_until/2).\n\n[count_until(arg1, arg2, arg3)](#count_until/3)\n\nSee [`REnum.count_until/3`](REnum.html#count_until/3).\n\n[cover?(arg1, arg2)](#cover?/2)\n\nSee [`RRange.Ruby.cover?/2`](RRange.Ruby.html#cover?/2).\n\n[cycle(arg1, arg2, arg3)](#cycle/3)\n\nSee [`REnum.cycle/3`](REnum.html#cycle/3).\n\n[dedup(arg1)](#dedup/1)\n\nSee [`REnum.dedup/1`](REnum.html#dedup/1).\n\n[dedup_by(arg1, arg2)](#dedup_by/2)\n\nSee [`REnum.dedup_by/2`](REnum.html#dedup_by/2).\n\n[detect(arg1, arg2)](#detect/2)\n\nSee [`REnum.detect/2`](REnum.html#detect/2).\n\n[detect(arg1, arg2, arg3)](#detect/3)\n\nSee [`REnum.detect/3`](REnum.html#detect/3).\n\n[disjoint?(arg1, arg2)](#disjoint?/2)\n\nSee [`Range.disjoint?/2`](https://hexdocs.pm/elixir/Range.html#disjoint?/2).\n\n[drop(arg1, arg2)](#drop/2)\n\nSee [`REnum.drop/2`](REnum.html#drop/2).\n\n[drop_every(arg1, arg2)](#drop_every/2)\n\nSee [`REnum.drop_every/2`](REnum.html#drop_every/2).\n\n[drop_while(arg1, arg2)](#drop_while/2)\n\nSee [`REnum.drop_while/2`](REnum.html#drop_while/2).\n\n[each(arg1, arg2)](#each/2)\n\nSee [`REnum.each/2`](REnum.html#each/2).\n\n[each_cons(arg1, arg2, arg3)](#each_cons/3)\n\nSee [`REnum.each_cons/3`](REnum.html#each_cons/3).\n\n[each_entry(arg1, arg2)](#each_entry/2)\n\nSee [`REnum.each_entry/2`](REnum.html#each_entry/2).\n\n[each_slice(arg1, arg2)](#each_slice/2)\n\nSee [`REnum.each_slice/2`](REnum.html#each_slice/2).\n\n[each_slice(arg1, arg2, arg3)](#each_slice/3)\n\nSee [`REnum.each_slice/3`](REnum.html#each_slice/3).\n\n[each_with_index(arg1)](#each_with_index/1)\n\nSee [`REnum.each_with_index/1`](REnum.html#each_with_index/1).\n\n[each_with_index(arg1, arg2)](#each_with_index/2)\n\nSee [`REnum.each_with_index/2`](REnum.html#each_with_index/2).\n\n[each_with_object(arg1, arg2, arg3)](#each_with_object/3)\n\nSee [`REnum.each_with_object/3`](REnum.html#each_with_object/3).\n\n[empty?(arg1)](#empty?/1)\n\nSee [`REnum.empty?/1`](REnum.html#empty?/1).\n\n[end(arg1)](#end/1)\n\nSee `RRange.Ruby.end/1`.\n\n[entries(arg1)](#entries/1)\n\nSee [`REnum.entries/1`](REnum.html#entries/1).\n\n[eql?(arg1, arg2)](#eql?/2)\n\nSee [`RRange.Ruby.eql?/2`](RRange.Ruby.html#eql?/2).\n\n[exclude?(arg1, arg2)](#exclude?/2)\n\nSee [`REnum.exclude?/2`](REnum.html#exclude?/2).\n\n[excluding(arg1, arg2)](#excluding/2)\n\nSee [`REnum.excluding/2`](REnum.html#excluding/2).\n\n[fetch(arg1, arg2)](#fetch/2)\n\nSee [`REnum.fetch/2`](REnum.html#fetch/2).\n\n[fetch!(arg1, arg2)](#fetch!/2)\n\nSee [`REnum.fetch!/2`](REnum.html#fetch!/2).\n\n[filter(arg1, arg2)](#filter/2)\n\nSee [`REnum.filter/2`](REnum.html#filter/2).\n\n[find(arg1, arg2)](#find/2)\n\nSee [`REnum.find/2`](REnum.html#find/2).\n\n[find(arg1, arg2, arg3)](#find/3)\n\nSee [`REnum.find/3`](REnum.html#find/3).\n\n[find_all(arg1, arg2)](#find_all/2)\n\nSee [`REnum.find_all/2`](REnum.html#find_all/2).\n\n[find_index(arg1, arg2)](#find_index/2)\n\nSee [`REnum.find_index/2`](REnum.html#find_index/2).\n\n[find_index_with_index(arg1, arg2)](#find_index_with_index/2)\n\nSee [`REnum.find_index_with_index/2`](REnum.html#find_index_with_index/2).\n\n[find_value(arg1, arg2)](#find_value/2)\n\nSee [`REnum.find_value/2`](REnum.html#find_value/2).\n\n[find_value(arg1, arg2, arg3)](#find_value/3)\n\nSee [`REnum.find_value/3`](REnum.html#find_value/3).\n\n[first(arg1)](#first/1)\n\nSee [`REnum.first/1`](REnum.html#first/1).\n\n[first(arg1, arg2)](#first/2)\n\nSee [`REnum.first/2`](REnum.html#first/2).\n\n[flat_map(arg1, arg2)](#flat_map/2)\n\nSee [`REnum.flat_map/2`](REnum.html#flat_map/2).\n\n[flat_map_reduce(arg1, arg2, arg3)](#flat_map_reduce/3)\n\nSee [`REnum.flat_map_reduce/3`](REnum.html#flat_map_reduce/3).\n\n[frequencies(arg1)](#frequencies/1)\n\nSee [`REnum.frequencies/1`](REnum.html#frequencies/1).\n\n[frequencies_by(arg1, arg2)](#frequencies_by/2)\n\nSee [`REnum.frequencies_by/2`](REnum.html#frequencies_by/2).\n\n[grep(arg1, arg2)](#grep/2)\n\nSee [`REnum.grep/2`](REnum.html#grep/2).\n\n[grep(arg1, arg2, arg3)](#grep/3)\n\nSee [`REnum.grep/3`](REnum.html#grep/3).\n\n[grep_v(arg1, arg2)](#grep_v/2)\n\nSee [`REnum.grep_v/2`](REnum.html#grep_v/2).\n\n[grep_v(arg1, arg2, arg3)](#grep_v/3)\n\nSee [`REnum.grep_v/3`](REnum.html#grep_v/3).\n\n[group_by(arg1, arg2)](#group_by/2)\n\nSee [`REnum.group_by/2`](REnum.html#group_by/2).\n\n[group_by(arg1, arg2, arg3)](#group_by/3)\n\nSee [`REnum.group_by/3`](REnum.html#group_by/3).\n\n[in_order_of(arg1, arg2, arg3)](#in_order_of/3)\n\nSee [`REnum.in_order_of/3`](REnum.html#in_order_of/3).\n\n[include?(arg1, arg2)](#include?/2)\n\nSee [`REnum.include?/2`](REnum.html#include?/2).\n\n[including(arg1, arg2)](#including/2)\n\nSee [`REnum.including/2`](REnum.html#including/2).\n\n[index_by(arg1, arg2)](#index_by/2)\n\nSee [`REnum.index_by/2`](REnum.html#index_by/2).\n\n[index_with(arg1, arg2)](#index_with/2)\n\nSee [`REnum.index_with/2`](REnum.html#index_with/2).\n\n[inject(arg1, arg2)](#inject/2)\n\nSee [`REnum.inject/2`](REnum.html#inject/2).\n\n[inject(arg1, arg2, arg3)](#inject/3)\n\nSee [`REnum.inject/3`](REnum.html#inject/3).\n\n[inspect(arg1)](#inspect/1)\n\nSee [`RRange.Ruby.inspect/1`](RRange.Ruby.html#inspect/1).\n\n[intersperse(arg1, arg2)](#intersperse/2)\n\nSee [`REnum.intersperse/2`](REnum.html#intersperse/2).\n\n[into(arg1, arg2)](#into/2)\n\nSee [`REnum.into/2`](REnum.html#into/2).\n\n[into(arg1, arg2, arg3)](#into/3)\n\nSee [`REnum.into/3`](REnum.html#into/3).\n\n[join(arg1)](#join/1)\n\nSee [`REnum.join/1`](REnum.html#join/1).\n\n[join(arg1, arg2)](#join/2)\n\nSee [`REnum.join/2`](REnum.html#join/2).\n\n[last(arg1)](#last/1)\n\nSee [`RRange.Ruby.last/1`](RRange.Ruby.html#last/1).\n\n[lazy(arg1)](#lazy/1)\n\nSee [`REnum.lazy/1`](REnum.html#lazy/1).\n\n[list_and_not_keyword?(arg1)](#list_and_not_keyword?/1)\n\nSee [`REnum.list_and_not_keyword?/1`](REnum.html#list_and_not_keyword?/1).\n\n[many?(arg1)](#many?/1)\n\nSee [`REnum.many?/1`](REnum.html#many?/1).\n\n[many?(arg1, arg2)](#many?/2)\n\nSee [`REnum.many?/2`](REnum.html#many?/2).\n\n[map(arg1, arg2)](#map/2)\n\nSee [`REnum.map/2`](REnum.html#map/2).\n\n[map_and_not_range?(arg1)](#map_and_not_range?/1)\n\nSee [`REnum.map_and_not_range?/1`](REnum.html#map_and_not_range?/1).\n\n[map_every(arg1, arg2, arg3)](#map_every/3)\n\nSee [`REnum.map_every/3`](REnum.html#map_every/3).\n\n[map_intersperse(arg1, arg2, arg3)](#map_intersperse/3)\n\nSee [`REnum.map_intersperse/3`](REnum.html#map_intersperse/3).\n\n[map_join(arg1, arg2)](#map_join/2)\n\nSee [`REnum.map_join/2`](REnum.html#map_join/2).\n\n[map_join(arg1, arg2, arg3)](#map_join/3)\n\nSee [`REnum.map_join/3`](REnum.html#map_join/3).\n\n[map_reduce(arg1, arg2, arg3)](#map_reduce/3)\n\nSee [`REnum.map_reduce/3`](REnum.html#map_reduce/3).\n\n[match_function(arg1)](#match_function/1)\n\nSee [`REnum.match_function/1`](REnum.html#match_function/1).\n\n[max(arg1)](#max/1)\n\nSee [`REnum.max/1`](REnum.html#max/1).\n\n[max(arg1, arg2)](#max/2)\n\nSee [`REnum.max/2`](REnum.html#max/2).\n\n[max(arg1, arg2, arg3)](#max/3)\n\nSee [`REnum.max/3`](REnum.html#max/3).\n\n[max_by(arg1, arg2)](#max_by/2)\n\nSee [`REnum.max_by/2`](REnum.html#max_by/2).\n\n[max_by(arg1, arg2, arg3)](#max_by/3)\n\nSee [`REnum.max_by/3`](REnum.html#max_by/3).\n\n[max_by(arg1, arg2, arg3, arg4)](#max_by/4)\n\nSee [`REnum.max_by/4`](REnum.html#max_by/4).\n\n[maximum(arg1, arg2)](#maximum/2)\n\nSee [`REnum.maximum/2`](REnum.html#maximum/2).\n\n[member?(arg1, arg2)](#member?/2)\n\nSee [`REnum.member?/2`](REnum.html#member?/2).\n\n[min(arg1)](#min/1)\n\nSee [`REnum.min/1`](REnum.html#min/1).\n\n[min(arg1, arg2)](#min/2)\n\nSee [`REnum.min/2`](REnum.html#min/2).\n\n[min(arg1, arg2, arg3)](#min/3)\n\nSee [`REnum.min/3`](REnum.html#min/3).\n\n[min_by(arg1, arg2)](#min_by/2)\n\nSee [`REnum.min_by/2`](REnum.html#min_by/2).\n\n[min_by(arg1, arg2, arg3)](#min_by/3)\n\nSee [`REnum.min_by/3`](REnum.html#min_by/3).\n\n[min_by(arg1, arg2, arg3, arg4)](#min_by/4)\n\nSee [`REnum.min_by/4`](REnum.html#min_by/4).\n\n[min_max(arg1)](#min_max/1)\n\nSee [`REnum.min_max/1`](REnum.html#min_max/1).\n\n[min_max(arg1, arg2)](#min_max/2)\n\nSee [`REnum.min_max/2`](REnum.html#min_max/2).\n\n[min_max_by(arg1, arg2)](#min_max_by/2)\n\nSee [`REnum.min_max_by/2`](REnum.html#min_max_by/2).\n\n[min_max_by(arg1, arg2, arg3)](#min_max_by/3)\n\nSee [`REnum.min_max_by/3`](REnum.html#min_max_by/3).\n\n[min_max_by(arg1, arg2, arg3, arg4)](#min_max_by/4)\n\nSee [`REnum.min_max_by/4`](REnum.html#min_max_by/4).\n\n[minimum(arg1, arg2)](#minimum/2)\n\nSee [`REnum.minimum/2`](REnum.html#minimum/2).\n\n[minmax(arg1)](#minmax/1)\n\nSee [`REnum.minmax/1`](REnum.html#minmax/1).\n\n[minmax(arg1, arg2)](#minmax/2)\n\nSee [`REnum.minmax/2`](REnum.html#minmax/2).\n\n[minmax_by(arg1, arg2)](#minmax_by/2)\n\nSee [`REnum.minmax_by/2`](REnum.html#minmax_by/2).\n\n[minmax_by(arg1, arg2, arg3)](#minmax_by/3)\n\nSee [`REnum.minmax_by/3`](REnum.html#minmax_by/3).\n\n[minmax_by(arg1, arg2, arg3, arg4)](#minmax_by/4)\n\nSee [`REnum.minmax_by/4`](REnum.html#minmax_by/4).\n\n[new(arg1, arg2)](#new/2)\n\nSee [`Range.new/2`](https://hexdocs.pm/elixir/Range.html#new/2).\n\n[new(arg1, arg2, arg3)](#new/3)\n\nSee [`Range.new/3`](https://hexdocs.pm/elixir/Range.html#new/3).\n\n[none?(arg1)](#none?/1)\n\nSee [`REnum.none?/1`](REnum.html#none?/1).\n\n[none?(arg1, arg2)](#none?/2)\n\nSee [`REnum.none?/2`](REnum.html#none?/2).\n\n[one?(arg1)](#one?/1)\n\nSee [`REnum.one?/1`](REnum.html#one?/1).\n\n[one?(arg1, arg2)](#one?/2)\n\nSee [`REnum.one?/2`](REnum.html#one?/2).\n\n[overlaps?(arg1, arg2)](#overlaps?/2)\n\nSee [`RRange.ActiveSupport.overlaps?/2`](RRange.ActiveSupport.html#overlaps?/2).\n\n[pick(arg1, arg2)](#pick/2)\n\nSee [`REnum.pick/2`](REnum.html#pick/2).\n\n[pluck(arg1, arg2)](#pluck/2)\n\nSee [`REnum.pluck/2`](REnum.html#pluck/2).\n\n[product(arg1)](#product/1)\n\nSee [`REnum.product/1`](REnum.html#product/1).\n\n[random(arg1)](#random/1)\n\nSee [`REnum.random/1`](REnum.html#random/1).\n\n[reduce(arg1, arg2)](#reduce/2)\n\nSee [`REnum.reduce/2`](REnum.html#reduce/2).\n\n[reduce(arg1, arg2, arg3)](#reduce/3)\n\nSee [`REnum.reduce/3`](REnum.html#reduce/3).\n\n[reduce_while(arg1, arg2, arg3)](#reduce_while/3)\n\nSee [`REnum.reduce_while/3`](REnum.html#reduce_while/3).\n\n[reject(arg1, arg2)](#reject/2)\n\nSee [`REnum.reject/2`](REnum.html#reject/2).\n\n[reverse(arg1)](#reverse/1)\n\nSee [`REnum.reverse/1`](REnum.html#reverse/1).\n\n[reverse(arg1, arg2)](#reverse/2)\n\nSee [`REnum.reverse/2`](REnum.html#reverse/2).\n\n[reverse_each(arg1, arg2)](#reverse_each/2)\n\nSee [`REnum.reverse_each/2`](REnum.html#reverse_each/2).\n\n[reverse_slice(arg1, arg2, arg3)](#reverse_slice/3)\n\nSee [`REnum.reverse_slice/3`](REnum.html#reverse_slice/3).\n\n[scan(arg1, arg2)](#scan/2)\n\nSee [`REnum.scan/2`](REnum.html#scan/2).\n\n[scan(arg1, arg2, arg3)](#scan/3)\n\nSee [`REnum.scan/3`](REnum.html#scan/3).\n\n[select(arg1, arg2)](#select/2)\n\nSee [`REnum.select/2`](REnum.html#select/2).\n\n[shuffle(arg1)](#shuffle/1)\n\nSee [`REnum.shuffle/1`](REnum.html#shuffle/1).\n\n[size(arg1)](#size/1)\n\nSee [`Range.size/1`](https://hexdocs.pm/elixir/Range.html#size/1).\n\n[slice(arg1, arg2)](#slice/2)\n\nSee [`REnum.slice/2`](REnum.html#slice/2).\n\n[slice(arg1, arg2, arg3)](#slice/3)\n\nSee [`REnum.slice/3`](REnum.html#slice/3).\n\n[slice_after(arg1, arg2)](#slice_after/2)\n\nSee [`REnum.slice_after/2`](REnum.html#slice_after/2).\n\n[slice_before(arg1, arg2)](#slice_before/2)\n\nSee [`REnum.slice_before/2`](REnum.html#slice_before/2).\n\n[slice_when(arg1, arg2)](#slice_when/2)\n\nSee [`REnum.slice_when/2`](REnum.html#slice_when/2).\n\n[slide(arg1, arg2, arg3)](#slide/3)\n\nSee [`REnum.slide/3`](REnum.html#slide/3).\n\n[sole(arg1)](#sole/1)\n\nSee [`REnum.sole/1`](REnum.html#sole/1).\n\n[sort(arg1)](#sort/1)\n\nSee [`REnum.sort/1`](REnum.html#sort/1).\n\n[sort(arg1, arg2)](#sort/2)\n\nSee [`REnum.sort/2`](REnum.html#sort/2).\n\n[sort_by(arg1, arg2)](#sort_by/2)\n\nSee [`REnum.sort_by/2`](REnum.html#sort_by/2).\n\n[sort_by(arg1, arg2, arg3)](#sort_by/3)\n\nSee [`REnum.sort_by/3`](REnum.html#sort_by/3).\n\n[split(arg1, arg2)](#split/2)\n\nSee [`REnum.split/2`](REnum.html#split/2).\n\n[split_while(arg1, arg2)](#split_while/2)\n\nSee [`REnum.split_while/2`](REnum.html#split_while/2).\n\n[split_with(arg1, arg2)](#split_with/2)\n\nSee [`REnum.split_with/2`](REnum.html#split_with/2).\n\n[step(arg1, arg2)](#step/2)\n\nSee [`RRange.Ruby.step/2`](RRange.Ruby.html#step/2).\n\n[step(arg1, arg2, arg3)](#step/3)\n\nSee [`RRange.Ruby.step/3`](RRange.Ruby.html#step/3).\n\n[sum(arg1)](#sum/1)\n\nSee [`REnum.sum/1`](REnum.html#sum/1).\n\n[take(arg1, arg2)](#take/2)\n\nSee [`REnum.take/2`](REnum.html#take/2).\n\n[take_every(arg1, arg2)](#take_every/2)\n\nSee [`REnum.take_every/2`](REnum.html#take_every/2).\n\n[take_random(arg1, arg2)](#take_random/2)\n\nSee [`REnum.take_random/2`](REnum.html#take_random/2).\n\n[take_while(arg1, arg2)](#take_while/2)\n\nSee [`REnum.take_while/2`](REnum.html#take_while/2).\n\n[tally(arg1)](#tally/1)\n\nSee [`REnum.tally/1`](REnum.html#tally/1).\n\n[to_a(arg1)](#to_a/1)\n\nSee [`REnum.to_a/1`](REnum.html#to_a/1).\n\n[to_h(arg1)](#to_h/1)\n\nSee [`REnum.to_h/1`](REnum.html#to_h/1).\n\n[to_h(arg1, arg2)](#to_h/2)\n\nSee [`REnum.to_h/2`](REnum.html#to_h/2).\n\n[to_l(arg1)](#to_l/1)\n\nSee [`REnum.to_l/1`](REnum.html#to_l/1).\n\n[to_list(arg1)](#to_list/1)\n\nSee [`REnum.to_list/1`](REnum.html#to_list/1).\n\n[to_s(arg1)](#to_s/1)\n\nSee [`RRange.Ruby.to_s/1`](RRange.Ruby.html#to_s/1).\n\n[truthy_count(arg1)](#truthy_count/1)\n\nSee [`REnum.truthy_count/1`](REnum.html#truthy_count/1).\n\n[truthy_count(arg1, arg2)](#truthy_count/2)\n\nSee [`REnum.truthy_count/2`](REnum.html#truthy_count/2).\n\n[uniq_by(arg1, arg2)](#uniq_by/2)\n\nSee [`REnum.uniq_by/2`](REnum.html#uniq_by/2).\n\n[unzip(arg1)](#unzip/1)\n\nSee [`REnum.unzip/1`](REnum.html#unzip/1).\n\n[with_index(arg1)](#with_index/1)\n\nSee [`REnum.with_index/1`](REnum.html#with_index/1).\n\n[with_index(arg1, arg2)](#with_index/2)\n\nSee [`REnum.with_index/2`](REnum.html#with_index/2).\n\n[without(arg1, arg2)](#without/2)\n\nSee [`REnum.without/2`](REnum.html#without/2).\n\n[zip(arg1)](#zip/1)\n\nSee [`REnum.zip/1`](REnum.html#zip/1).\n\n[zip(arg1, arg2)](#zip/2)\n\nSee [`REnum.zip/2`](REnum.html#zip/2).\n\n[zip_reduce(arg1, arg2, arg3)](#zip_reduce/3)\n\nSee [`REnum.zip_reduce/3`](REnum.html#zip_reduce/3).\n\n[zip_reduce(arg1, arg2, arg3, arg4)](#zip_reduce/4)\n\nSee [`REnum.zip_reduce/4`](REnum.html#zip_reduce/4).\n\n[zip_with(arg1, arg2)](#zip_with/2)\n\nSee [`REnum.zip_with/2`](REnum.html#zip_with/2).\n\n[zip_with(arg1, arg2, arg3)](#zip_with/3)\n\nSee [`REnum.zip_with/3`](REnum.html#zip_with/3).\n\n[Link to this section](#functions)\nFunctions\n===\n\nRRange.ActiveSupport\n===\n\nSummarized all of List functions in Rails.ActiveSupport.\nIf a function with the same name already exists in Elixir, that is not implemented.\nDefines all of here functions when `use RRange.ActiveSupport`.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[overlaps?(range1, range2)](#overlaps?/2)\n\nCompare two ranges and see if they overlap each other.\n\n[Link to this section](#functions)\nFunctions\n===\n\nRRange.Native\n===\n\nA module defines all of native Range functions when `use RRange.Native`.\n[See also.](https://hexdocs.pm/elixir/Range.html)\n\nRRange.Ruby\n===\n\nSummarized all of Ruby's Range functions.\nFunctions corresponding to the following patterns are not implemented\n\n* When a function with the same name already exists in Elixir.\n* When a method name includes `!`.\n* %, ==, ===\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[begin(arg)](#begin/1)\n\nReturns the first element of range.\n\n[cover?(range, n)](#cover?/2)\n\nSee [`Enum.member?/2`](https://hexdocs.pm/elixir/Enum.html#member?/2).\n\n[end(range)](#end/1)\n\nSee [`RRange.Ruby.last/1`](#last/1).\n\n[eql?(range1, range2)](#eql?/2)\n\nReturns true if list1 == list2.\n\n[inspect(range)](#inspect/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[last(arg)](#last/1)\n\nReturns the last element of range.\n\n[step(arg, step)](#step/2)\n\nReturns Stream that from given range split into by given step.\n\n[step(arg, step, func)](#step/3)\n\nExecutes `Enum.each` to g given range split into by given step.\n\n[to_s(range)](#to_s/1)\n\nSee [`Kernel.inspect/1`](https://hexdocs.pm/elixir/Kernel.html#inspect/1).\n\n[Link to this section](#functions)\nFunctions\n===\n\nRRange.RubyEnd\n===\n\nRStream\n===\n\nEntry point of Stream extensions, and can use all of RStream.* and REnum functions.\nSee also.\n\n* [RStream.Native](https://hexdocs.pm/r_enum/RStream.Native.html#content)\n* [REnum](https://hexdocs.pm/r_enum/REnum.html#content)\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[all?(arg1)](#all?/1)\n\nSee [`REnum.all?/1`](REnum.html#all?/1).\n\n[all?(arg1, arg2)](#all?/2)\n\nSee [`REnum.all?/2`](REnum.html#all?/2).\n\n[any?(arg1)](#any?/1)\n\nSee [`REnum.any?/1`](REnum.html#any?/1).\n\n[any?(arg1, arg2)](#any?/2)\n\nSee [`REnum.any?/2`](REnum.html#any?/2).\n\n[at(arg1, arg2)](#at/2)\n\nSee [`REnum.at/2`](REnum.html#at/2).\n\n[at(arg1, arg2, arg3)](#at/3)\n\nSee [`REnum.at/3`](REnum.html#at/3).\n\n[chain(arg1)](#chain/1)\n\nSee [`REnum.chain/1`](REnum.html#chain/1).\n\n[chain(arg1, arg2)](#chain/2)\n\nSee [`REnum.chain/2`](REnum.html#chain/2).\n\n[chunk_by(arg1, arg2)](#chunk_by/2)\n\nSee [`Stream.chunk_by/2`](https://hexdocs.pm/elixir/Stream.html#chunk_by/2).\n\n[chunk_every(arg1, arg2)](#chunk_every/2)\n\nSee [`Stream.chunk_every/2`](https://hexdocs.pm/elixir/Stream.html#chunk_every/2).\n\n[chunk_every(arg1, arg2, arg3)](#chunk_every/3)\n\nSee [`Stream.chunk_every/3`](https://hexdocs.pm/elixir/Stream.html#chunk_every/3).\n\n[chunk_every(arg1, arg2, arg3, arg4)](#chunk_every/4)\n\nSee [`Stream.chunk_every/4`](https://hexdocs.pm/elixir/Stream.html#chunk_every/4).\n\n[chunk_while(arg1, arg2, arg3, arg4)](#chunk_while/4)\n\nSee [`Stream.chunk_while/4`](https://hexdocs.pm/elixir/Stream.html#chunk_while/4).\n\n[collect(arg1, arg2)](#collect/2)\n\nSee [`REnum.collect/2`](REnum.html#collect/2).\n\n[collect_concat(arg1, arg2)](#collect_concat/2)\n\nSee [`REnum.collect_concat/2`](REnum.html#collect_concat/2).\n\n[compact(arg1)](#compact/1)\n\nSee [`REnum.compact/1`](REnum.html#compact/1).\n\n[compact_blank(arg1)](#compact_blank/1)\n\nSee [`REnum.compact_blank/1`](REnum.html#compact_blank/1).\n\n[concat(arg1)](#concat/1)\n\nSee [`Stream.concat/1`](https://hexdocs.pm/elixir/Stream.html#concat/1).\n\n[concat(arg1, arg2)](#concat/2)\n\nSee [`Stream.concat/2`](https://hexdocs.pm/elixir/Stream.html#concat/2).\n\n[count(arg1)](#count/1)\n\nSee [`REnum.count/1`](REnum.html#count/1).\n\n[count(arg1, arg2)](#count/2)\n\nSee [`REnum.count/2`](REnum.html#count/2).\n\n[count_until(arg1, arg2)](#count_until/2)\n\nSee [`REnum.count_until/2`](REnum.html#count_until/2).\n\n[count_until(arg1, arg2, arg3)](#count_until/3)\n\nSee [`REnum.count_until/3`](REnum.html#count_until/3).\n\n[cycle(arg1)](#cycle/1)\n\nSee [`Stream.cycle/1`](https://hexdocs.pm/elixir/Stream.html#cycle/1).\n\n[dedup(arg1)](#dedup/1)\n\nSee [`Stream.dedup/1`](https://hexdocs.pm/elixir/Stream.html#dedup/1).\n\n[dedup_by(arg1, arg2)](#dedup_by/2)\n\nSee [`Stream.dedup_by/2`](https://hexdocs.pm/elixir/Stream.html#dedup_by/2).\n\n[detect(arg1, arg2)](#detect/2)\n\nSee [`REnum.detect/2`](REnum.html#detect/2).\n\n[detect(arg1, arg2, arg3)](#detect/3)\n\nSee [`REnum.detect/3`](REnum.html#detect/3).\n\n[drop(arg1, arg2)](#drop/2)\n\nSee [`Stream.drop/2`](https://hexdocs.pm/elixir/Stream.html#drop/2).\n\n[drop_every(arg1, arg2)](#drop_every/2)\n\nSee [`Stream.drop_every/2`](https://hexdocs.pm/elixir/Stream.html#drop_every/2).\n\n[drop_while(arg1, arg2)](#drop_while/2)\n\nSee [`Stream.drop_while/2`](https://hexdocs.pm/elixir/Stream.html#drop_while/2).\n\n[each(arg1, arg2)](#each/2)\n\nSee [`Stream.each/2`](https://hexdocs.pm/elixir/Stream.html#each/2).\n\n[each_cons(arg1, arg2, arg3)](#each_cons/3)\n\nSee [`REnum.each_cons/3`](REnum.html#each_cons/3).\n\n[each_entry(arg1, arg2)](#each_entry/2)\n\nSee [`REnum.each_entry/2`](REnum.html#each_entry/2).\n\n[each_slice(arg1, arg2)](#each_slice/2)\n\nSee [`REnum.each_slice/2`](REnum.html#each_slice/2).\n\n[each_slice(arg1, arg2, arg3)](#each_slice/3)\n\nSee [`REnum.each_slice/3`](REnum.html#each_slice/3).\n\n[each_with_index(arg1)](#each_with_index/1)\n\nSee [`REnum.each_with_index/1`](REnum.html#each_with_index/1).\n\n[each_with_index(arg1, arg2)](#each_with_index/2)\n\nSee [`REnum.each_with_index/2`](REnum.html#each_with_index/2).\n\n[each_with_object(arg1, arg2, arg3)](#each_with_object/3)\n\nSee [`REnum.each_with_object/3`](REnum.html#each_with_object/3).\n\n[empty?(arg1)](#empty?/1)\n\nSee [`REnum.empty?/1`](REnum.html#empty?/1).\n\n[entries(arg1)](#entries/1)\n\nSee [`REnum.entries/1`](REnum.html#entries/1).\n\n[exclude?(arg1, arg2)](#exclude?/2)\n\nSee [`REnum.exclude?/2`](REnum.html#exclude?/2).\n\n[excluding(arg1, arg2)](#excluding/2)\n\nSee [`REnum.excluding/2`](REnum.html#excluding/2).\n\n[fetch(arg1, arg2)](#fetch/2)\n\nSee [`REnum.fetch/2`](REnum.html#fetch/2).\n\n[fetch!(arg1, arg2)](#fetch!/2)\n\nSee [`REnum.fetch!/2`](REnum.html#fetch!/2).\n\n[filter(arg1, arg2)](#filter/2)\n\nSee [`Stream.filter/2`](https://hexdocs.pm/elixir/Stream.html#filter/2).\n\n[find(arg1, arg2)](#find/2)\n\nSee [`REnum.find/2`](REnum.html#find/2).\n\n[find(arg1, arg2, arg3)](#find/3)\n\nSee [`REnum.find/3`](REnum.html#find/3).\n\n[find_all(arg1, arg2)](#find_all/2)\n\nSee [`REnum.find_all/2`](REnum.html#find_all/2).\n\n[find_index(arg1, arg2)](#find_index/2)\n\nSee [`REnum.find_index/2`](REnum.html#find_index/2).\n\n[find_index_with_index(arg1, arg2)](#find_index_with_index/2)\n\nSee [`REnum.find_index_with_index/2`](REnum.html#find_index_with_index/2).\n\n[find_value(arg1, arg2)](#find_value/2)\n\nSee [`REnum.find_value/2`](REnum.html#find_value/2).\n\n[find_value(arg1, arg2, arg3)](#find_value/3)\n\nSee [`REnum.find_value/3`](REnum.html#find_value/3).\n\n[first(arg1)](#first/1)\n\nSee [`REnum.first/1`](REnum.html#first/1).\n\n[first(arg1, arg2)](#first/2)\n\nSee [`REnum.first/2`](REnum.html#first/2).\n\n[flat_map(arg1, arg2)](#flat_map/2)\n\nSee [`Stream.flat_map/2`](https://hexdocs.pm/elixir/Stream.html#flat_map/2).\n\n[flat_map_reduce(arg1, arg2, arg3)](#flat_map_reduce/3)\n\nSee [`REnum.flat_map_reduce/3`](REnum.html#flat_map_reduce/3).\n\n[frequencies(arg1)](#frequencies/1)\n\nSee [`REnum.frequencies/1`](REnum.html#frequencies/1).\n\n[frequencies_by(arg1, arg2)](#frequencies_by/2)\n\nSee [`REnum.frequencies_by/2`](REnum.html#frequencies_by/2).\n\n[grep(arg1, arg2)](#grep/2)\n\nSee [`REnum.grep/2`](REnum.html#grep/2).\n\n[grep(arg1, arg2, arg3)](#grep/3)\n\nSee [`REnum.grep/3`](REnum.html#grep/3).\n\n[grep_v(arg1, arg2)](#grep_v/2)\n\nSee [`REnum.grep_v/2`](REnum.html#grep_v/2).\n\n[grep_v(arg1, arg2, arg3)](#grep_v/3)\n\nSee [`REnum.grep_v/3`](REnum.html#grep_v/3).\n\n[group_by(arg1, arg2)](#group_by/2)\n\nSee [`REnum.group_by/2`](REnum.html#group_by/2).\n\n[group_by(arg1, arg2, arg3)](#group_by/3)\n\nSee [`REnum.group_by/3`](REnum.html#group_by/3).\n\n[in_order_of(arg1, arg2, arg3)](#in_order_of/3)\n\nSee [`REnum.in_order_of/3`](REnum.html#in_order_of/3).\n\n[include?(arg1, arg2)](#include?/2)\n\nSee [`REnum.include?/2`](REnum.html#include?/2).\n\n[including(arg1, arg2)](#including/2)\n\nSee [`REnum.including/2`](REnum.html#including/2).\n\n[index_by(arg1, arg2)](#index_by/2)\n\nSee [`REnum.index_by/2`](REnum.html#index_by/2).\n\n[index_with(arg1, arg2)](#index_with/2)\n\nSee [`REnum.index_with/2`](REnum.html#index_with/2).\n\n[inject(arg1, arg2)](#inject/2)\n\nSee [`REnum.inject/2`](REnum.html#inject/2).\n\n[inject(arg1, arg2, arg3)](#inject/3)\n\nSee [`REnum.inject/3`](REnum.html#inject/3).\n\n[intersperse(arg1, arg2)](#intersperse/2)\n\nSee [`Stream.intersperse/2`](https://hexdocs.pm/elixir/Stream.html#intersperse/2).\n\n[interval(arg1)](#interval/1)\n\nSee [`Stream.interval/1`](https://hexdocs.pm/elixir/Stream.html#interval/1).\n\n[into(arg1, arg2)](#into/2)\n\nSee [`Stream.into/2`](https://hexdocs.pm/elixir/Stream.html#into/2).\n\n[into(arg1, arg2, arg3)](#into/3)\n\nSee [`Stream.into/3`](https://hexdocs.pm/elixir/Stream.html#into/3).\n\n[iterate(arg1, arg2)](#iterate/2)\n\nSee [`Stream.iterate/2`](https://hexdocs.pm/elixir/Stream.html#iterate/2).\n\n[join(arg1)](#join/1)\n\nSee [`REnum.join/1`](REnum.html#join/1).\n\n[join(arg1, arg2)](#join/2)\n\nSee [`REnum.join/2`](REnum.html#join/2).\n\n[lazy(arg1)](#lazy/1)\n\nSee [`REnum.lazy/1`](REnum.html#lazy/1).\n\n[list_and_not_keyword?(arg1)](#list_and_not_keyword?/1)\n\nSee [`REnum.list_and_not_keyword?/1`](REnum.html#list_and_not_keyword?/1).\n\n[many?(arg1)](#many?/1)\n\nSee [`REnum.many?/1`](REnum.html#many?/1).\n\n[many?(arg1, arg2)](#many?/2)\n\nSee [`REnum.many?/2`](REnum.html#many?/2).\n\n[map(arg1, arg2)](#map/2)\n\nSee [`Stream.map/2`](https://hexdocs.pm/elixir/Stream.html#map/2).\n\n[map_and_not_range?(arg1)](#map_and_not_range?/1)\n\nSee [`REnum.map_and_not_range?/1`](REnum.html#map_and_not_range?/1).\n\n[map_every(arg1, arg2, arg3)](#map_every/3)\n\nSee [`Stream.map_every/3`](https://hexdocs.pm/elixir/Stream.html#map_every/3).\n\n[map_intersperse(arg1, arg2, arg3)](#map_intersperse/3)\n\nSee [`REnum.map_intersperse/3`](REnum.html#map_intersperse/3).\n\n[map_join(arg1, arg2)](#map_join/2)\n\nSee [`REnum.map_join/2`](REnum.html#map_join/2).\n\n[map_join(arg1, arg2, arg3)](#map_join/3)\n\nSee [`REnum.map_join/3`](REnum.html#map_join/3).\n\n[map_reduce(arg1, arg2, arg3)](#map_reduce/3)\n\nSee [`REnum.map_reduce/3`](REnum.html#map_reduce/3).\n\n[match_function(arg1)](#match_function/1)\n\nSee [`REnum.match_function/1`](REnum.html#match_function/1).\n\n[max(arg1)](#max/1)\n\nSee [`REnum.max/1`](REnum.html#max/1).\n\n[max(arg1, arg2)](#max/2)\n\nSee [`REnum.max/2`](REnum.html#max/2).\n\n[max(arg1, arg2, arg3)](#max/3)\n\nSee [`REnum.max/3`](REnum.html#max/3).\n\n[max_by(arg1, arg2)](#max_by/2)\n\nSee [`REnum.max_by/2`](REnum.html#max_by/2).\n\n[max_by(arg1, arg2, arg3)](#max_by/3)\n\nSee [`REnum.max_by/3`](REnum.html#max_by/3).\n\n[max_by(arg1, arg2, arg3, arg4)](#max_by/4)\n\nSee [`REnum.max_by/4`](REnum.html#max_by/4).\n\n[maximum(arg1, arg2)](#maximum/2)\n\nSee [`REnum.maximum/2`](REnum.html#maximum/2).\n\n[member?(arg1, arg2)](#member?/2)\n\nSee [`REnum.member?/2`](REnum.html#member?/2).\n\n[min(arg1)](#min/1)\n\nSee [`REnum.min/1`](REnum.html#min/1).\n\n[min(arg1, arg2)](#min/2)\n\nSee [`REnum.min/2`](REnum.html#min/2).\n\n[min(arg1, arg2, arg3)](#min/3)\n\nSee [`REnum.min/3`](REnum.html#min/3).\n\n[min_by(arg1, arg2)](#min_by/2)\n\nSee [`REnum.min_by/2`](REnum.html#min_by/2).\n\n[min_by(arg1, arg2, arg3)](#min_by/3)\n\nSee [`REnum.min_by/3`](REnum.html#min_by/3).\n\n[min_by(arg1, arg2, arg3, arg4)](#min_by/4)\n\nSee [`REnum.min_by/4`](REnum.html#min_by/4).\n\n[min_max(arg1)](#min_max/1)\n\nSee [`REnum.min_max/1`](REnum.html#min_max/1).\n\n[min_max(arg1, arg2)](#min_max/2)\n\nSee [`REnum.min_max/2`](REnum.html#min_max/2).\n\n[min_max_by(arg1, arg2)](#min_max_by/2)\n\nSee [`REnum.min_max_by/2`](REnum.html#min_max_by/2).\n\n[min_max_by(arg1, arg2, arg3)](#min_max_by/3)\n\nSee [`REnum.min_max_by/3`](REnum.html#min_max_by/3).\n\n[min_max_by(arg1, arg2, arg3, arg4)](#min_max_by/4)\n\nSee [`REnum.min_max_by/4`](REnum.html#min_max_by/4).\n\n[minimum(arg1, arg2)](#minimum/2)\n\nSee [`REnum.minimum/2`](REnum.html#minimum/2).\n\n[minmax(arg1)](#minmax/1)\n\nSee [`REnum.minmax/1`](REnum.html#minmax/1).\n\n[minmax(arg1, arg2)](#minmax/2)\n\nSee [`REnum.minmax/2`](REnum.html#minmax/2).\n\n[minmax_by(arg1, arg2)](#minmax_by/2)\n\nSee [`REnum.minmax_by/2`](REnum.html#minmax_by/2).\n\n[minmax_by(arg1, arg2, arg3)](#minmax_by/3)\n\nSee [`REnum.minmax_by/3`](REnum.html#minmax_by/3).\n\n[minmax_by(arg1, arg2, arg3, arg4)](#minmax_by/4)\n\nSee [`REnum.minmax_by/4`](REnum.html#minmax_by/4).\n\n[none?(arg1)](#none?/1)\n\nSee [`REnum.none?/1`](REnum.html#none?/1).\n\n[none?(arg1, arg2)](#none?/2)\n\nSee [`REnum.none?/2`](REnum.html#none?/2).\n\n[one?(arg1)](#one?/1)\n\nSee [`REnum.one?/1`](REnum.html#one?/1).\n\n[one?(arg1, arg2)](#one?/2)\n\nSee [`REnum.one?/2`](REnum.html#one?/2).\n\n[pick(arg1, arg2)](#pick/2)\n\nSee [`REnum.pick/2`](REnum.html#pick/2).\n\n[pluck(arg1, arg2)](#pluck/2)\n\nSee [`REnum.pluck/2`](REnum.html#pluck/2).\n\n[product(arg1)](#product/1)\n\nSee [`REnum.product/1`](REnum.html#product/1).\n\n[random(arg1)](#random/1)\n\nSee [`REnum.random/1`](REnum.html#random/1).\n\n[range?(arg1)](#range?/1)\n\nSee [`REnum.range?/1`](REnum.html#range?/1).\n\n[reduce(arg1, arg2)](#reduce/2)\n\nSee [`REnum.reduce/2`](REnum.html#reduce/2).\n\n[reduce(arg1, arg2, arg3)](#reduce/3)\n\nSee [`REnum.reduce/3`](REnum.html#reduce/3).\n\n[reduce_while(arg1, arg2, arg3)](#reduce_while/3)\n\nSee [`REnum.reduce_while/3`](REnum.html#reduce_while/3).\n\n[reject(arg1, arg2)](#reject/2)\n\nSee [`Stream.reject/2`](https://hexdocs.pm/elixir/Stream.html#reject/2).\n\n[repeatedly(arg1)](#repeatedly/1)\n\nSee [`Stream.repeatedly/1`](https://hexdocs.pm/elixir/Stream.html#repeatedly/1).\n\n[resource(arg1, arg2, arg3)](#resource/3)\n\nSee [`Stream.resource/3`](https://hexdocs.pm/elixir/Stream.html#resource/3).\n\n[reverse(arg1)](#reverse/1)\n\nSee [`REnum.reverse/1`](REnum.html#reverse/1).\n\n[reverse(arg1, arg2)](#reverse/2)\n\nSee [`REnum.reverse/2`](REnum.html#reverse/2).\n\n[reverse_each(arg1, arg2)](#reverse_each/2)\n\nSee [`REnum.reverse_each/2`](REnum.html#reverse_each/2).\n\n[reverse_slice(arg1, arg2, arg3)](#reverse_slice/3)\n\nSee [`REnum.reverse_slice/3`](REnum.html#reverse_slice/3).\n\n[run(arg1)](#run/1)\n\nSee [`Stream.run/1`](https://hexdocs.pm/elixir/Stream.html#run/1).\n\n[scan(arg1, arg2)](#scan/2)\n\nSee [`Stream.scan/2`](https://hexdocs.pm/elixir/Stream.html#scan/2).\n\n[scan(arg1, arg2, arg3)](#scan/3)\n\nSee [`Stream.scan/3`](https://hexdocs.pm/elixir/Stream.html#scan/3).\n\n[select(arg1, arg2)](#select/2)\n\nSee [`REnum.select/2`](REnum.html#select/2).\n\n[shuffle(arg1)](#shuffle/1)\n\nSee [`REnum.shuffle/1`](REnum.html#shuffle/1).\n\n[slice(arg1, arg2)](#slice/2)\n\nSee [`REnum.slice/2`](REnum.html#slice/2).\n\n[slice(arg1, arg2, arg3)](#slice/3)\n\nSee [`REnum.slice/3`](REnum.html#slice/3).\n\n[slice_after(arg1, arg2)](#slice_after/2)\n\nSee [`REnum.slice_after/2`](REnum.html#slice_after/2).\n\n[slice_before(arg1, arg2)](#slice_before/2)\n\nSee [`REnum.slice_before/2`](REnum.html#slice_before/2).\n\n[slice_when(arg1, arg2)](#slice_when/2)\n\nSee [`REnum.slice_when/2`](REnum.html#slice_when/2).\n\n[slide(arg1, arg2, arg3)](#slide/3)\n\nSee [`REnum.slide/3`](REnum.html#slide/3).\n\n[sole(arg1)](#sole/1)\n\nSee [`REnum.sole/1`](REnum.html#sole/1).\n\n[sort(arg1)](#sort/1)\n\nSee [`REnum.sort/1`](REnum.html#sort/1).\n\n[sort(arg1, arg2)](#sort/2)\n\nSee [`REnum.sort/2`](REnum.html#sort/2).\n\n[sort_by(arg1, arg2)](#sort_by/2)\n\nSee [`REnum.sort_by/2`](REnum.html#sort_by/2).\n\n[sort_by(arg1, arg2, arg3)](#sort_by/3)\n\nSee [`REnum.sort_by/3`](REnum.html#sort_by/3).\n\n[split(arg1, arg2)](#split/2)\n\nSee [`REnum.split/2`](REnum.html#split/2).\n\n[split_while(arg1, arg2)](#split_while/2)\n\nSee [`REnum.split_while/2`](REnum.html#split_while/2).\n\n[split_with(arg1, arg2)](#split_with/2)\n\nSee [`REnum.split_with/2`](REnum.html#split_with/2).\n\n[sum(arg1)](#sum/1)\n\nSee [`REnum.sum/1`](REnum.html#sum/1).\n\n[take(arg1, arg2)](#take/2)\n\nSee [`Stream.take/2`](https://hexdocs.pm/elixir/Stream.html#take/2).\n\n[take_every(arg1, arg2)](#take_every/2)\n\nSee [`Stream.take_every/2`](https://hexdocs.pm/elixir/Stream.html#take_every/2).\n\n[take_random(arg1, arg2)](#take_random/2)\n\nSee [`REnum.take_random/2`](REnum.html#take_random/2).\n\n[take_while(arg1, arg2)](#take_while/2)\n\nSee [`Stream.take_while/2`](https://hexdocs.pm/elixir/Stream.html#take_while/2).\n\n[tally(arg1)](#tally/1)\n\nSee [`REnum.tally/1`](REnum.html#tally/1).\n\n[timer(arg1)](#timer/1)\n\nSee [`Stream.timer/1`](https://hexdocs.pm/elixir/Stream.html#timer/1).\n\n[to_a(arg1)](#to_a/1)\n\nSee [`REnum.to_a/1`](REnum.html#to_a/1).\n\n[to_h(arg1)](#to_h/1)\n\nSee [`REnum.to_h/1`](REnum.html#to_h/1).\n\n[to_h(arg1, arg2)](#to_h/2)\n\nSee [`REnum.to_h/2`](REnum.html#to_h/2).\n\n[to_l(arg1)](#to_l/1)\n\nSee [`REnum.to_l/1`](REnum.html#to_l/1).\n\n[to_list(arg1)](#to_list/1)\n\nSee [`REnum.to_list/1`](REnum.html#to_list/1).\n\n[transform(arg1, arg2, arg3)](#transform/3)\n\nSee [`Stream.transform/3`](https://hexdocs.pm/elixir/Stream.html#transform/3).\n\n[transform(arg1, arg2, arg3, arg4)](#transform/4)\n\nSee [`Stream.transform/4`](https://hexdocs.pm/elixir/Stream.html#transform/4).\n\n[truthy_count(arg1)](#truthy_count/1)\n\nSee [`REnum.truthy_count/1`](REnum.html#truthy_count/1).\n\n[truthy_count(arg1, arg2)](#truthy_count/2)\n\nSee [`REnum.truthy_count/2`](REnum.html#truthy_count/2).\n\n[unfold(arg1, arg2)](#unfold/2)\n\nSee [`Stream.unfold/2`](https://hexdocs.pm/elixir/Stream.html#unfold/2).\n\n[uniq_by(arg1, arg2)](#uniq_by/2)\n\nSee [`Stream.uniq_by/2`](https://hexdocs.pm/elixir/Stream.html#uniq_by/2).\n\n[unzip(arg1)](#unzip/1)\n\nSee [`REnum.unzip/1`](REnum.html#unzip/1).\n\n[with_index(arg1)](#with_index/1)\n\nSee [`Stream.with_index/1`](https://hexdocs.pm/elixir/Stream.html#with_index/1).\n\n[with_index(arg1, arg2)](#with_index/2)\n\nSee [`Stream.with_index/2`](https://hexdocs.pm/elixir/Stream.html#with_index/2).\n\n[without(arg1, arg2)](#without/2)\n\nSee [`REnum.without/2`](REnum.html#without/2).\n\n[zip(arg1)](#zip/1)\n\nSee [`Stream.zip/1`](https://hexdocs.pm/elixir/Stream.html#zip/1).\n\n[zip(arg1, arg2)](#zip/2)\n\nSee [`Stream.zip/2`](https://hexdocs.pm/elixir/Stream.html#zip/2).\n\n[zip_reduce(arg1, arg2, arg3)](#zip_reduce/3)\n\nSee [`REnum.zip_reduce/3`](REnum.html#zip_reduce/3).\n\n[zip_reduce(arg1, arg2, arg3, arg4)](#zip_reduce/4)\n\nSee [`REnum.zip_reduce/4`](REnum.html#zip_reduce/4).\n\n[zip_with(arg1, arg2)](#zip_with/2)\n\nSee [`Stream.zip_with/2`](https://hexdocs.pm/elixir/Stream.html#zip_with/2).\n\n[zip_with(arg1, arg2, arg3)](#zip_with/3)\n\nSee [`Stream.zip_with/3`](https://hexdocs.pm/elixir/Stream.html#zip_with/3).\n\n[Link to this section](#functions)\nFunctions\n===\n\nRStream.ActiveSupport\n===\n\nUnimplemented.\n\nRStream.Native\n===\n\nA module defines all of native Stream functions when `use RStream.Native`.\n[See also.](https://hexdocs.pm/elixir/Stream.html)\n\nRStream.Ruby\n===\n\nUnimplemented.\n\nRUtils\n===\n\nUtils for REnum.\n\n[Link to this section](#summary)\n Summary\n===\n\n[Functions](#functions)\n---\n\n[blank?(map)](#blank?/1)\n\nReturn true if object is blank, false, empty, or a whitespace string.\nFor example, +nil+, '', ' ', [], {}, and +false+ are all blank.\n\n[define_all_functions!(mod, undelegate_functions \\\\ [])](#define_all_functions!/2)\n\nDefines in the module that called all the functions of the argument module.\n\n[make_args(n)](#make_args/1)\n\nCreates tuple for `unquote_splicing`.\n\n[present?(obj)](#present?/1)\n\nReturns true if not `RUtils.blank?`\n\n[Link to this section](#functions)\nFunctions\n===\n\nSoleItemExpectedError exception\n==="}}},{"rowIdx":453,"cells":{"project":{"kind":"string","value":"github.com/shurcool/vfsgen"},"source":{"kind":"string","value":"go"},"language":{"kind":"string","value":"Go"},"content":{"kind":"string","value":"README\n [¶](#section-readme)\n---\n\n### vfsgen\n\n[![Build Status](https://travis-ci.org/shurcooL/vfsgen.svg?branch=master)](https://travis-ci.org/shurcooL/vfsgen) [![GoDoc](https://godoc.org/github.com/shurcooL/vfsgen?status.svg)](https://godoc.org/github.com/shurcooL/vfsgen)\n\nPackage vfsgen takes an http.FileSystem (likely at `go generate` time) and generates Go code that statically implements the provided http.FileSystem.\n\nFeatures:\n\n* Efficient generated code without unneccessary overhead.\n* Uses gzip compression internally (selectively, only for files that compress well).\n* Enables direct access to internal gzip compressed bytes via an optional interface.\n* Outputs `gofmt`ed Go code.\n\n#### Installation\n```\ngo get -u github.com/shurcooL/vfsgen\n```\n#### Usage\n\nPackage `vfsgen` is a Go code generator library. It has a `Generate` function that takes an input filesystem (as a [`http.FileSystem`](https://godoc.org/net/http#FileSystem) type), and generates a Go code file that statically implements the contents of the input filesystem.\n\nFor example, we can use [`http.Dir`](https://godoc.org/net/http#Dir) as a `http.FileSystem` implementation that uses the contents of the `/path/to/assets` directory:\n```\nvar fs http.FileSystem = http.Dir(\"/path/to/assets\")\n```\nNow, when you execute the following code:\n```\nerr := vfsgen.Generate(fs, vfsgen.Options{})\nif err != nil {\n\tlog.Fatalln(err)\n}\n```\nAn assets_vfsdata.go file will be generated in the current directory:\n```\n// Code generated by vfsgen; DO NOT EDIT.\n\npackage main\n\nimport ...\n\n// assets statically implements the virtual filesystem provided to vfsgen.Generate.\nvar assets http.FileSystem = ...\n```\nThen, in your program, you can use `assets` as any other [`http.FileSystem`](https://godoc.org/net/http#FileSystem), for example:\n```\nfile, err := assets.Open(\"/some/file.txt\")\nif err != nil {\n\treturn err\n}\ndefer file.Close()\n```\n```\nhttp.Handle(\"/assets/\", http.FileServer(assets))\n```\n`vfsgen` can be more useful when combined with build tags and go generate directives. This is described below.\n\n##### `go generate` Usage\n\nvfsgen is great to use with go generate directives. The code invoking `vfsgen.Generate` can go in an assets_generate.go file, which can then be invoked via \"//go:generate go run assets_generate.go\". The input virtual filesystem can read directly from disk, or it can be more involved.\n\nBy using build tags, you can create a development mode where assets are loaded directly from disk via `http.Dir`, but then statically implemented for final releases.\n\nFor example, suppose your source filesystem is defined in a package with import path \"example.com/project/data\" as:\n```\n// +build dev\n\npackage data\n\nimport \"net/http\"\n\n// Assets contains project assets.\nvar Assets http.FileSystem = http.Dir(\"assets\")\n```\nWhen built with the \"dev\" build tag, accessing `data.Assets` will read from disk directly via `http.Dir`.\n\nA generate helper file assets_generate.go can be invoked via \"//go:generate go run -tags=dev assets_generate.go\" directive:\n```\n// +build ignore\n\npackage main\n\nimport (\n\t\"log\"\n\n\t\"example.com/project/data\"\n\t\"github.com/shurcooL/vfsgen\"\n)\n\nfunc main() {\n\terr := vfsgen.Generate(data.Assets, vfsgen.Options{\n\t\tPackageName:  \"data\",\n\t\tBuildTags:    \"!dev\",\n\t\tVariableName: \"Assets\",\n\t})\n\tif err != nil {\n\t\tlog.Fatalln(err)\n\t}\n}\n```\nNote that \"dev\" build tag is used to access the source filesystem, and the output file will contain \"!dev\" build tag. That way, the statically implemented version will be used during normal builds and `go get`, when custom builds tags are not specified.\n\n##### `vfsgendev` Usage\n\n`vfsgendev` is a binary that can be used to replace the need for the assets_generate.go file.\n\nMake sure it's installed and available in your PATH.\n```\ngo get -u github.com/shurcooL/vfsgen/cmd/vfsgendev\n```\nThen the \"//go:generate go run -tags=dev assets_generate.go\" directive can be replaced with:\n```\n//go:generate vfsgendev -source=\"example.com/project/data\".Assets\n```\nvfsgendev accesses the source variable using \"dev\" build tag, and generates an output file with \"!dev\" build tag.\n\n##### Additional Embedded Information\n\nAll compressed files implement [`httpgzip.GzipByter` interface](https://godoc.org/github.com/shurcooL/httpgzip#GzipByter) for efficient direct access to the internal compressed bytes:\n```\n// GzipByter is implemented by compressed files for\n// efficient direct access to the internal compressed bytes.\ntype GzipByter interface {\n\t// GzipBytes returns gzip compressed contents of the file.\n\tGzipBytes() []byte\n}\n```\nFiles that have been determined to not be worth gzip compressing (their compressed size is larger than original) implement [`httpgzip.NotWorthGzipCompressing` interface](https://godoc.org/github.com/shurcooL/httpgzip#NotWorthGzipCompressing):\n```\n// NotWorthGzipCompressing is implemented by files that were determined\n// not to be worth gzip compressing (the file size did not decrease as a result).\ntype NotWorthGzipCompressing interface {\n\t// NotWorthGzipCompressing is a noop. It's implemented in order to indicate\n\t// the file is not worth gzip compressing.\n\tNotWorthGzipCompressing()\n}\n```\n#### Comparison\n\nvfsgen aims to be conceptually simple to use. The [`http.FileSystem`](https://godoc.org/net/http#FileSystem) abstraction is central to vfsgen. It's used as both input for code generation, and as output in the generated code.\n\nThat enables great flexibility through orthogonality, since helpers and wrappers can operate on `http.FileSystem` without knowing about vfsgen. If you want, you can perform pre-processing, minifying assets, merging folders, filtering out files and otherwise modifying input via generic `http.FileSystem` middleware.\n\nIt avoids unneccessary overhead by merging what was previously done with two distinct packages into a single package.\n\nIt strives to be the best in its class in terms of code quality and efficiency of generated code. However, if your use goals are different, there are other similar packages that may fit your needs better.\n\n##### Alternatives\n\n* [`go-bindata`](https://github.com/jteeuwen/go-bindata) - Reads from disk, generates Go code that provides access to data via a [custom API](https://github.com/jteeuwen/go-bindata#accessing-an-asset).\n* [`go-bindata-assetfs`](https://github.com/elazarl/go-bindata-assetfs) - Takes output of go-bindata and provides a wrapper that implements `http.FileSystem` interface (the same as what vfsgen outputs directly).\n* [`becky`](https://github.com/tv42/becky) - Embeds assets as string literals in Go source.\n* [`statik`](https://github.com/rakyll/statik) - Embeds a directory of static files to be accessed via `http.FileSystem` interface (sounds very similar to vfsgen); implementation sourced from [camlistore](https://camlistore.org).\n* [`go.rice`](https://github.com/GeertJohan/go.rice) - Makes working with resources such as HTML, JS, CSS, images and templates very easy.\n* [`esc`](https://github.com/mjibson/esc) - Embeds files into Go programs and provides `http.FileSystem` interfaces to them.\n* [`staticfiles`](https://github.com/bouk/staticfiles) - Allows you to embed a directory of files into your Go binary.\n* [`togo`](https://github.com/flazz/togo) - Generates a Go source file with a `[]byte` var containing the given file's contents.\n* [`fileb0x`](https://github.com/UnnoTed/fileb0x) - Simple customizable tool to embed files in Go.\n* [`embedfiles`](https://github.com/leighmcculloch/embedfiles) - Simple tool for embedding files in Go code as a map.\n* [`packr`](https://github.com/gobuffalo/packr) - Simple solution for bundling static assets inside of Go binaries.\n* [`rsrc`](https://github.com/akavel/rsrc) - Tool for embedding .ico & manifest resources in Go programs for Windows.\n\n#### Attribution\n\nThis package was originally based on the excellent work by [@jteeuwen](https://github.com/jteeuwen) on [`go-bindata`](https://github.com/jteeuwen/go-bindata) and [@elazarl](https://github.com/elazarl) on [`go-bindata-assetfs`](https://github.com/elazarl/go-bindata-assetfs).\n\n#### License\n\n* [MIT License](https://github.com/shurcool/vfsgen/blob/0d455de96546/LICENSE)\n\nDocumentation\n [¶](#section-documentation)\n---\n\n \n### Overview [¶](#pkg-overview)\n\nPackage vfsgen takes an http.FileSystem (likely at `go generate` time) and generates Go code that statically implements the provided http.FileSystem.\n\nFeatures:\n\n- Efficient generated code without unneccessary overhead.\n\n- Uses gzip compression internally (selectively, only for files that compress well).\n\n- Enables direct access to internal gzip compressed bytes via an optional interface.\n\n- Outputs `gofmt`ed Go code.\n\nExample [¶](#example-package)\n\nThis code will generate an assets_vfsdata.go file with\n`var assets http.FileSystem = ...`\nthat statically implements the contents of \"assets\" directory.\n\nvfsgen is great to use with go generate directives. This code can go in an assets_gen.go file, which can then be invoked via \"//go:generate go run assets_gen.go\". The input virtual filesystem can read directly from disk, or it can be more involved.\n```\npackage main\n\nimport (\n\t\"log\"\n\t\"net/http\"\n\n\t\"github.com/shurcooL/vfsgen\"\n)\n\nfunc main() {\n\tvar fs http.FileSystem = http.Dir(\"assets\")\n\n\terr := vfsgen.Generate(fs, vfsgen.Options{})\n\tif err != nil {\n\t\tlog.Fatalln(err)\n\t}\n}\n```\n```\nOutput:\n```\nShare Format\nRun\n\n### Index [¶](#pkg-index)\n\n* [func Generate(input http.FileSystem, opt Options) error](#Generate)\n* [type Options](#Options)\n\n#### Examples [¶](#pkg-examples)\n\n* [Package](#example-package)\n\n### Constants [¶](#pkg-constants)\n\nThis section is empty.\n\n### Variables [¶](#pkg-variables)\n\nThis section is empty.\n\n### Functions [¶](#pkg-functions)\n\n#### \nfunc [Generate](https://github.com/shurcool/vfsgen/blob/0d455de96546/generator.go#L22) [¶](#Generate)\n```\nfunc Generate(input [http](/net/http).[FileSystem](/net/http#FileSystem), opt [Options](#Options)) [error](/builtin#error)\n```\nGenerate Go code that statically implements input filesystem,\nwrite the output to a file specified in opt.\n\n### Types [¶](#pkg-types)\n\n#### \ntype [Options](https://github.com/shurcool/vfsgen/blob/0d455de96546/options.go#L9) [¶](#Options)\n```\ntype Options struct {\n // Filename of the generated Go code output (including extension).\n\t// If left empty, it defaults to \"{{toLower .VariableName}}_vfsdata.go\".\n\tFilename [string](/builtin#string)\n\n // PackageName is the name of the package in the generated code.\n\t// If left empty, it defaults to \"main\".\n\tPackageName [string](/builtin#string)\n\n // BuildTags are the optional build tags in the generated code.\n\t// The build tags syntax is specified by the go tool.\n\tBuildTags [string](/builtin#string)\n\n // VariableName is the name of the http.FileSystem variable in the generated code.\n\t// If left empty, it defaults to \"assets\".\n\tVariableName [string](/builtin#string)\n\n // VariableComment is the comment of the http.FileSystem variable in the generated code.\n\t// If left empty, it defaults to \"{{.VariableName}} statically implements the virtual filesystem provided to vfsgen.\".\n\tVariableComment [string](/builtin#string)\n}\n```\nOptions for vfsgen code generation."}}},{"rowIdx":454,"cells":{"project":{"kind":"string","value":"asynci-box"},"source":{"kind":"string","value":"readthedoc"},"language":{"kind":"string","value":"Python"},"content":{"kind":"string","value":"aiotools 2.1.0.dev15+g14aa2b4 documentation\n\n[aiotools](#)\n\n---\n\naiotools Documentation[](#aiotools-documentation)\n===\n\n**aiotools** is a set of idiomatic utilities to reduce asyncio boiler-plates.\n\nAsync Context Manager[](#module-aiotools.context)\n---\n\nProvides an implementation of asynchronous context manager and its applications.\n\nNote\n\nThe async context managers in this module are transparent aliases to\n`contextlib.asynccontextmanager` of the standard library in Python 3.7 and later.\n\n*class* AbstractAsyncContextManager[[source]](_modules/contextlib.html#AbstractAsyncContextManager)[](#aiotools.context.AbstractAsyncContextManager)\nAn abstract base class for asynchronous context managers.\n\nAsyncContextManager[](#aiotools.context.AsyncContextManager)\nalias of `contextlib._AsyncGeneratorContextManager`\n\nasync_ctx_manager(*func*)[](#aiotools.context.async_ctx_manager)\nA helper function to ease use of `AsyncContextManager`.\n\nactxmgr(*func*)[](#aiotools.context.actxmgr)\nAn alias of [`async_ctx_manager()`](#aiotools.context.async_ctx_manager).\n\n*class* aclosing(*thing*)[[source]](_modules/contextlib.html#aclosing)[](#aiotools.context.aclosing)\nAsync context manager for safely finalizing an asynchronously cleaned-up resource such as an async generator, calling its `aclose()` method.\n\nCode like this:\n\n> async with aclosing(.fetch()) as agen:\nis equivalent to this:\n\n> agen = .fetch()\n> try:\n> > > \n> > > > finally:await agen.aclose()\n*class* closing_async(*thing: aiotools.context.T_AsyncClosable*)[[source]](_modules/aiotools/context.html#closing_async)[](#aiotools.context.closing_async)\nAn analogy to [`contextlib.closing()`](https://docs.python.org/3/library/contextlib.html#contextlib.closing) for objects defining the `close()`\nmethod as an async function.\n\nNew in version 1.5.6.\n\n*class* AsyncContextGroup(*context_managers: [Optional](https://docs.python.org/3/library/typing.html#typing.Optional)[[Iterable](https://docs.python.org/3/library/typing.html#typing.Iterable)[[contextlib.AbstractAsyncContextManager](index.html#aiotools.context.AbstractAsyncContextManager)]] = None*)[[source]](_modules/aiotools/context.html#AsyncContextGroup)[](#aiotools.context.AsyncContextGroup)\nMerges a group of context managers into a single context manager.\nInternally it uses [`asyncio.gather()`](https://docs.python.org/3/library/asyncio-task.html#asyncio.gather) to execute them with overlapping,\nto reduce the execution time via asynchrony.\n\nUpon entering, you can get values produced by the entering steps from the passed context managers (those `yield`-ed) using an `as` clause of the `async with`\nstatement.\n\nAfter exits, you can check if the context managers have finished successfully by ensuring that the return values of `exit_states()` method are `None`.\n\nNote\n\nYou cannot return values in context managers because they are generators.\n\nIf an exception is raised before the `yield` statement of an async context manager, it is stored at the corresponding manager index in the as-clause variable. Similarly, if an exception is raised after the\n`yield` statement of an async context manager, it is stored at the corresponding manager index in the `exit_states()` return value.\n\nAny exceptions in a specific context manager does not interrupt others;\nthis semantic is same to `asyncio.gather()`’s when\n`return_exceptions=True`. This means that, it is user’s responsibility to check if the returned context values are exceptions or the intended ones inside the context body after entering.\n\nParameters\n**context_managers** – An iterable of async context managers.\nIf this is `None`, you may add async context managers one by one using the [`add()`](#aiotools.context.AsyncContextGroup.add)\nmethod.\n\nExample:\n```\n@aiotools.actxmgr async def ctx(v):\n  yield v + 10\n\ng = aiotools.actxgroup([ctx(1), ctx(2)])\n\nasync with g as values:\n    assert values[0] == 11\n    assert values[1] == 12\n\nrets = g.exit_states()\nassert rets[0] is None  # successful shutdown assert rets[1] is None\n```\nadd(*cm*)[[source]](_modules/aiotools/context.html#AsyncContextGroup.add)[](#aiotools.context.AsyncContextGroup.add)\nTODO: fill description\n\nexit_states()[[source]](_modules/aiotools/context.html#AsyncContextGroup.exit_states)[](#aiotools.context.AsyncContextGroup.exit_states)\nTODO: fill description\n\n*class* actxgroup[](#aiotools.context.actxgroup)\nAn alias of [`AsyncContextGroup`](#aiotools.context.AsyncContextGroup).\n\nAsync Deferred Function Tools[](#module-aiotools.defer)\n---\n\nProvides a Golang-like `defer()` API using decorators, which allows grouping resource initialization and cleanup in one place without extra indentations.\n\nExample:\n```\nasync def init(x):\n    ...\n\nasync def cleanup(x):\n    ...\n\n@aiotools.adefer async def do(defer):  # <-- be aware of defer argument!\n    x = SomeResource()\n    await init(x)\n    defer(cleanup(x))\n    ...\n    ...\n```\nThis is equivalent to:\n```\nasync def do():\n    x = SomeResource()\n    await init(x)\n    try:\n        ...\n        ...\n    finally:\n        await cleanup(x)\n```\nNote that [`aiotools.context.AsyncContextGroup`](index.html#aiotools.context.AsyncContextGroup) or\n[`contextlib.AsyncExitStack`](https://docs.python.org/3/library/contextlib.html#contextlib.AsyncExitStack) serves well for the same purpose, but for simple cleanups, this defer API makes your codes simple because it steps aside the main execution context without extra indentations.\n\nWarning\n\nAny exception in the deferred functions is raised transparently, and may block execution of the remaining deferred functions.\nThis behavior may be changed in the future versions, though.\n\ndefer(*func*)[[source]](_modules/aiotools/defer.html#defer)[](#aiotools.defer.defer)\nA synchronous version of the defer API.\nIt can only defer normal functions.\n\nadefer(*func*)[[source]](_modules/aiotools/defer.html#adefer)[](#aiotools.defer.adefer)\nAn asynchronous version of the defer API.\nIt can defer coroutine functions, coroutines, and normal functions.\n\nAsync Fork[](#module-aiotools.fork)\n---\n\nThis module implements a simple [`os.fork()`](https://docs.python.org/3/library/os.html#os.fork)-like interface,\nbut in an asynchronous way with full support for PID file descriptors on Python 3.9 or higher and the Linux kernel 5.4 or higher.\n\nIt internally synchronizes the beginning and readiness status of child processes so that the users may assume that the child process is completely interruptible after\n[`afork()`](#aiotools.fork.afork) returns.\n\n*class* AbstractChildProcess[[source]](_modules/aiotools/fork.html#AbstractChildProcess)[](#aiotools.fork.AbstractChildProcess)\nThe abstract interface to control and monitor a forked child process.\n\n*abstract* send_signal(*signum: [int](https://docs.python.org/3/library/functions.html#int)*) → [None](https://docs.python.org/3/library/constants.html#None)[[source]](_modules/aiotools/fork.html#AbstractChildProcess.send_signal)[](#aiotools.fork.AbstractChildProcess.send_signal)\nSend a UNIX signal to the child process.\nIf the child process is already terminated, it will log a warning message and return.\n\n*abstract async* wait() → [int](https://docs.python.org/3/library/functions.html#int)[[source]](_modules/aiotools/fork.html#AbstractChildProcess.wait)[](#aiotools.fork.AbstractChildProcess.wait)\nWait until the child process terminates or reclaim the child process’ exit code if already terminated.\nIf there are other coroutines that has waited the same process, it may return 255 and log a warning message.\n\nPosixChildProcess(*pid: [int](https://docs.python.org/3/library/functions.html#int)*) → [None](https://docs.python.org/3/library/constants.html#None)[[source]](_modules/aiotools/fork.html#PosixChildProcess)[](#aiotools.fork.PosixChildProcess)\nA POSIX-compatible version of [`AbstractChildProcess`](#aiotools.fork.AbstractChildProcess).\n\nPidfdChildProcess(*pid: [int](https://docs.python.org/3/library/functions.html#int)*, *pidfd: [int](https://docs.python.org/3/library/functions.html#int)*) → [None](https://docs.python.org/3/library/constants.html#None)[[source]](_modules/aiotools/fork.html#PidfdChildProcess)[](#aiotools.fork.PidfdChildProcess)\nA PID file descriptor-based version of [`AbstractChildProcess`](#aiotools.fork.AbstractChildProcess).\n\n*async* afork(*child_func: [Callable](https://docs.python.org/3/library/typing.html#typing.Callable)[[], [int](https://docs.python.org/3/library/functions.html#int)]*) → [aiotools.fork.AbstractChildProcess](index.html#aiotools.fork.AbstractChildProcess)[[source]](_modules/aiotools/fork.html#afork)[](#aiotools.fork.afork)\nFork the current process and execute the given function in the child.\nThe return value of the function will become the exit code of the child process.\n\nParameters\n**child_func** – A function that represents the main function of the child and returns an integer as its exit code.\nNote that the function must set up a new event loop if it wants to run asyncio codes.\n\nAsync Function Tools[](#module-aiotools.func)\n---\n\napartial(*coro*, **args*, ***kwargs*)[[source]](_modules/aiotools/func.html#apartial)[](#aiotools.func.apartial)\nWraps a coroutine function with pre-defined arguments (including keyword arguments). It is an asynchronous version of [`functools.partial()`](https://docs.python.org/3/library/functools.html#functools.partial).\n\nlru_cache(*maxsize: [int](https://docs.python.org/3/library/functions.html#int) = 128*, *typed: [bool](https://docs.python.org/3/library/functions.html#bool) = False*, *expire_after: [Optional](https://docs.python.org/3/library/typing.html#typing.Optional)[[float](https://docs.python.org/3/library/functions.html#float)] = None*)[[source]](_modules/aiotools/func.html#lru_cache)[](#aiotools.func.lru_cache)\nA simple LRU cache just like [`functools.lru_cache()`](https://docs.python.org/3/library/functools.html#functools.lru_cache), but it works for coroutines. This is not as heavily optimized as [`functools.lru_cache()`](https://docs.python.org/3/library/functools.html#functools.lru_cache)\nwhich uses an internal C implementation, as it targets async operations that take a long time.\n\nIt follows the same API that the standard functools provides. The wrapped function has `cache_clear()` method to flush the cache manually, but leaves `cache_info()` for statistics unimplemented.\n\nNote that calling the coroutine multiple times with the same arguments before the first call returns may incur duplicate executions.\n\nThis function is not thread-safe.\n\nParameters\n* **maxsize** – The maximum number of cached entries.\n* **typed** – Cache keys in different types separately (e.g., `3` and `3.0` will be different keys).\n* **expire_after** – Re-calculate the value if the configured time has passed even when the cache is hit. When re-calculation happens the expiration timer is also reset.\n\nAsync Itertools[](#module-aiotools.iter)\n---\n\n*async* aiter(*obj*, *sentinel=