actix/actix-extras

Document using protobuf from the client

Open

#67 opened on May 29, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (227 forks)auto 404
A-protobufC-documentationgood first issue

Repository metrics

Stars
 (889 stars)
PR merge metrics
 (PR metrics pending)

Description

Expected Behavior

There is no documentation about constructing protobuf messages to issue HTTP requests from the client only HTTPResponses are covered.

Current Behavior

The documentation and example only cover server side and doesn't cover client.

Possible Solution

Add more documentation and maybe example app.

Steps to Reproduce (for bugs)

N/A

Context

I am trying to implement an app which acts both as http client and server and therefore need to be able to construct protobuf messages and include them in both HTTResponse and HTTRequest.

Your Environment

  • Rust Version (I.e, output of rustc -V): 1.43.1
  • Actix-* crate(s) Version:
    • actix: 0.9.0
    • actix-protobuf: 0.5.1

Contributor guide

Research direction
Add documentation and example code for constructing protobuf messages for HTTP client requests, following the existing server side examples.
Tech stack
rust
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rustactixprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80