Introduce LinkMessageBuilder #73
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@little-dude I could use your expertise on this PR review. |
cathay4t
force-pushed
the
link_builder
branch
2 times, most recently
from
aa1820a
to
531bf57
Compare
**API BREAK**
To remove the duplicate error of `LinkAddRequest` and `LinkSetRequest`,
this patch introduce `LinkMessageBuilder` to generate `LinkMessage` for
link handlers to use.
The `impl LinkMessageBuilder<T>` holds the common functions available for all
interface types.
The `impl LinkMessageBuilder<LinkVlan>` holds VLAN specific functions.
The LinkMessageBuilder is designed for advanced user, wrapper functions
are created for common use cases. For example, to create a VLAN
interface:
```rus
let (connection, handle, _) = new_connection().unwrap();
tokio::spawn(connection);
handle
.link()
.add(
LinkVlan::new("vlan100", 10, 100)
.up()
.build()
)
.execute()
.await
.map_err(|e| format!("{e}"))
```
These patches included these new structures to generate matching
LinkMessageBuilder:
* `LinkUnspec` (for matching existing interface)
* `LinkDummy`
* `LinkVeth`
* `LinkVlan`
* `LinkVxlan`
* `LinkMacVlan`
* `LinkMacVtap`
* `LinkWireguard`
* `LinkBondPort`
Special note:
* Due to confliction, the previous VxLAN `link()` function changed to
`dev()`. The `link()` is the share function for all interface types. The
API is matching with `ip link` command line option for vxlan.
Please check `examples/create_vxlan.rs` for usage.
* The `LinkHandler::set_bond_port()` changed to
`LinkHandler::set_port()`, please check `examples/set_bond_port.rs`
for usage.
* The `message_mut()` function is removed from `LinkSetRequest` and
`LinkAddRequest`, user should modify the LinkMessage before sent to
handler.
Signed-off-by: Gris Ge <[email protected]>
Signed-off-by: Gris Ge <[email protected]>
|
@little-dude Do you have any free time for this PR? |
|
@little-dude ping again |
|
Let's move on and fix stuff later. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API BREAK
To remove the duplicate error of
LinkAddRequestandLinkSetRequest,this patch introduce
LinkMessageBuilderto generateLinkMessageforlink handlers to use.
The
impl LinkMessageBuilder<T>holds the common functions available for allinterface types.
The
impl LinkMessageBuilder<LinkVlan>holds VLAN specific functions.The LinkMessageBuilder is designed for advanced user, wrapper functions
are created for common use cases. For example, to create a VLAN
interface:
These patches included these new structures to generate matching
LinkMessageBuilder:
LinkUnspec(for matching existing interface)LinkDummyLinkVethLinkVlanLinkVxlanLinkMacVlanLinkMacVtapLinkWireguardLinkBondPortSpecial note:
Due to confliction, the previous VxLAN
link()function changed todev(). Thelink()is the share function for all interface types. TheAPI is matching with
ip linkcommand line option for vxlan.Please check
examples/create_vxlan.rsfor usage.The
LinkHandler::set_bond_port()changed toLinkHandler::set_port(), please checkexamples/set_bond_port.rsfor usage.
The
message_mut()function is removed fromLinkSetRequestandLinkAddRequest, user should modify the LinkMessage before sent tohandler.