Discuss name of DataPayload get method

[sffc]

@zbraniecki said in #739:

I strongly believe borrow is a better name here than get.

I replied:

There are some things I like about borrow, and I considered it, but I used get because:

• It's shorter
• It's what Yoke uses
• .borrow() is the name of the function in the std::borrow::Borrow trait, which we are not implementing

Discuss.

[sffc]

Bikeshed:

• .as_data()
• .as_inner()
• .get_inner()
• .borrow_inner()

[sffc]

• @zbraniecki - I think it's okay to have a function with the same name as the standard library trait if it is similar; for example, .iter() does not necessarily return an Iterator.
• @nordzilla - I'm okay re-using the same method name
• @echeran - What's wrong with .get() ?
• @zbraniecki - Usually .get() is fallible, and gets something out of a collection, but here you are borrowing an inner type. So it's more like RefCell, which has a .borrow() function.
• @Manishearth - Perhaps .as() or .as_borrow() or .inner()?
• @dminor - I like .inner()
• @nordzilla - I like .inner() or .borrow_inner()

Resolution: use .inner(), for now only on DataPayload. @Manishearth can decide whether to also change Yoke.

[sffc]

I want to revisit the decision above, because .inner() is a bit of a misnomer: we're returning the yoked object, not the yoke itself. I would expect .inner() to return a Yoke<T, C>, but instead we return T directly.

I prefer to keep .get() and close this issue.

[sffc]

2021-07-29: Okay. Keep .get(). Zibi is 2/10.