add ring module

[WGB5445]

Pull request type

Please check the type of change your PR introduces:

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Build related changes
• Documentation content changes
• Other (please describe):

What is the new behavior?

我增加了一个新的数据结构 Ring ：
Ring 的使用场景是需要保留一段数据在一个缓冲区中，可以在更新时进行覆盖
并实现了几个函数

    struct Ring<Element> has drop{
        v  : vector<Element>,
        i  : u64
    }

public fun empty<Element>(): Ring<Element>

public fun length<Element>(r: &Ring<Element>): u64

public fun add_element<Element>(r: &mut Ring<Element>, e: Element)

public fun delete_element<Element>(r: &mut Ring<Element>):Element

public fun remove_element<Element>(r: &mut Ring<Element>, i: u64):Element

public fun set<Element>(r: &mut Ring<Element>):&mut Element

public fun borrow<Element>(r:& Ring<Element>, i: u64):&Element

public fun borrow_mut<Element>(r: &mut Ring<Element>, i: u64):&mut Element

public fun is_empty<Element>(r:&Ring<Element>): bool

public fun index_of<Element>(r:&Ring<Element>, e: &Element):Option::Option<u64>

public fun get_index<Element>(r: &Ring<Element>):u64

[jolestar]

可以参考下

https://en.wikipedia.org/wiki/Circular_buffer

以及 Rust 实现：

https://github.com/YaLTeR/circular-queue

[jolestar]

@0xpause 邀请你了，也帮忙一起 review 下

[pause125]

我觉得一下几个方法不适合 Ring 结构：

1. 获取 index：get_index，index_of
2. 随机访问borrow, borrow_mut, remove_element

不知道什么场景在使用 Ring 结构时需要这些方法？

[jolestar]

2. 随机访问borrow, borrow_mut, remove_element

不知道什么场景在使用 Ring 结构时需要这些方法？

这种还是有需要的吧？主要 Move 中也没办法提供类似 iter 的遍历接口，遍历的时候就需要按 index 访问吧？

[WGB5445]

这种还是有需要的吧？主要 Move 中也没办法提供类似 iter 的遍历接口，遍历的时候就需要按 index 访问吧？

这里的 index 有两种类型：

1. 用底层的 vec index （Ring 容量 5， borrow(&r, 0 ~ 4 )）
2. 用一个递增 u64，内部去处理 ( Ring 容量 5， borrow(&r, 0 ~ n ) ,内部做 n % 5 处理)
   这两种哪种更好一些？我比较倾向于 第二种

[jolestar]

这种还是有需要的吧？主要 Move 中也没办法提供类似 iter 的遍历接口，遍历的时候就需要按 index 访问吧？

这里的 index 有两种类型：

1. 用底层的 vec index （Ring 容量 5， borrow(&r, 0 ~ 4 )）
2. 用一个递增 u64，内部去处理 ( Ring 容量 5， borrow(&r, 0 ~ n ) ,内部做 n % 5 处理)
   这两种哪种更好一些？我比较倾向于 第二种

应该第二种吧，使用方可以把 ring 假设成一个无限长的 vector 用。

[jolestar]

方法上需要加一些注释

[jolestar]

感觉 index 相关的几个方法要再通过测试用例覆盖一下。

[jolestar]

LGTM