Một Số Tùy Chọn để Tìm Đường Trong Rust

Tìm đường là một vấn đề quan trọng trong nhiều ứng dụng. Trong bài viết này, chúng ta sẽ xem xét một số tùy chọn để tìm đường bằng ngôn ngữ Rust.

Tìm kiếm con đường là gì?

Nói một cách đơn giản, tìm đường là tìm đường ngắn nhất giữa hai điểm. Trong trường hợp đơn giản nhất, câu trả lời là “một đường thẳng”, nhưng mọi thứ có thể trở nên phức tạp hơn nhiều!

Một số ví dụ về các yếu tố phức tạp là:

• Những chướng ngại vật không thể vượt qua
• Địa hình khó di chuyển hơn

Ví dụ: để xử lý các địa hình khó di chuyển hơn, bạn có thể cung cấp cho hai điểm chi phí để di chuyển qua. Sau đó, bạn có thể thay đổi mục tiêu để tìm tuyến đường giữa hai điểm đó với chi phí thấp nhất.

Cách sử dụng của tìm đường

Pathfinding được sử dụng trong nhiều ứng dụng. Một số trong những trò chơi phổ biến nhất là rô bốt và trò chơi điện tử, chẳng hạn như trò chơi mô phỏng .

Trong lĩnh vực chế tạo rô bốt, nhiệm vụ chung của rô bốt là điều hướng môi trường và đi từ điểm A đến điểm B càng nhanh càng tốt.

Trong trò chơi điện tử, một nhân vật do máy tính điều khiển có thể cần di chuyển các vị trí trong môi trường. Ngoài ra, nếu trò chơi cho phép người chơi thiết lập các điểm tham chiếu, họ cũng có thể muốn chỉ ra cách nhanh nhất để đến điểm tham chiếu tiếp theo.

Các ví dụ về tìm đường trong Rust

Bây giờ chúng ta đã thiết lập tính hữu ích của tìm đường, hãy cùng xem một vài ví dụ về tìm đường trong Rust, một ngôn ngữ lập trình ngày càng phổ biến .

Đối với những ví dụ này, chúng tôi sẽ sử dụng thùng có tên aptly, là pathfindingthùng tìm đường phổ biến nhất hiện có trên cơ quan đăng ký thùng của cộng đồng Rust .

 

Lưu ý rằng hầu hết các thuật toán tìm đường hoạt động theo các nút thay vì không gian liên tục. Bài viết dành cho nhà phát triển trò chơi này thảo luận về một số cách để làm cho kết quả của các thuật toán này trông tự nhiên hơn.

Khuôn khổ tìm kiếm đường dẫn Rust mẫu

Bạn có thể xem toàn bộ mã mà chúng tôi sẽ sử dụng trong repo GitHub này .

Cấu Boardtrúc xác định một bảng hình chữ nhật trong đó mỗi ô có thể là một chướng ngại vật hoặc có chi phí liên quan đến việc di chuyển đến nó.

Board::new()cho phép tạo bảng và chỉ định các ô này bằng a Vec<string>. Trong chuỗi này, một ký tự có giá trị từ một đến chín biểu thị một ô có thể được chuyển đến với chi phí đã xác định. Trong khi đó, một ký tự "X" chỉ ra một chướng ngại vật.

Lưu ý rằng các thuật toán này hỗ trợ có liên kết một chiều giữa các ô. Để đơn giản, chúng tôi sẽ không cho phép chức năng đó trong Boardcấu trúc.

Board::get_successors()nhận vào một vị trí ô và trả về một Vectrong các ô có thể được di chuyển trực tiếp đến cùng với chi phí của chúng. Như chúng ta sẽ thấy, đây là một phương pháp chính được sử dụng trong tất cả các thuật toán mà chúng ta sẽ xem xét trong thùng tìm đường.

Ngoài ra còn có Board::draw_to_image(), đây là một cách thuận tiện để viết một hình ảnh với các Boardô - và tùy chọn, cũng là một đường dẫn. Phương pháp này sử dụng imageprocthùng để vẽ.

Sử dụng tìm kiếm theo chiều rộng để tìm kiếm đường dẫn trong Rust

Tìm kiếm theo chiều rộng là một thuật toán khá đơn giản để tìm đường đi ngắn nhất từ ​​nút bắt đầu đến nút mục tiêu. Bắt đầu từ nút bắt đầu, nó xử lý từng nút được kết nối tại một thời điểm.

Nếu nút đó là nút mục tiêu, thì chúng ta đã hoàn tất! Nếu không, chúng tôi đặt mỗi kết nối của nó trong hàng đợi các nút để xem xét và tiếp tục.

Thuật toán tìm kiếm theo chiều rộng không xem xét chi phí của các nút, nhưng nó là một ví dụ khá đơn giản để bắt đầu. Bạn có thể xem toàn bộ nguồn cho ví dụ này bằng cách sử dụng tìm kiếm theo chiều rộng để làm theo.

Đoạn mã dưới đây cho thấy lời kêu gọi thực sự thực hiện tìm kiếm theo chiều rộng-ưu tiên:

    let result = bfs(
        &start,
        |p| board.get_successors(p).iter().map(|successor| successor.pos).collect::<Vec<_>>(), 
        |p| *p==goal);

Theo tài liệu chobfs() , các đối số là:

• Nút để bắt đầu
• Một hàm nhận một nút và trả về một Vectrong số các nút có thể được chuyển trực tiếp đến
• Một hàm nhận một nút và trả về liệu nó có phải là nút mục tiêu hay không

Lưu ý rằng vì tìm kiếm theo chiều rộng không hỗ trợ chi phí cho các nút, chúng tôi phải lập bản đồ kết quả của Board::get_successors()để loại bỏ chi phí.

Ngoài ra, như tài liệu lưu ý, việc tham gia vào một nút và trả lại xem đó có phải là nút mục tiêu hay không sẽ linh hoạt hơn so với việc chỉ xem nút mục tiêu là gì. Điều này là do nó cho phép nhiều nút mục tiêu hoặc một số loại tính toán động để biết liệu một nút có phải là mục tiêu hay không.

Trong trường hợp này, chúng tôi chỉ muốn một nút mục tiêu và điều đó cũng dễ thực hiện!

bfs()trả về Option<Vec<N>>đâu Nlà loại nút bạn đã truyền vào. Đó là Option<>vì có thể không có đường dẫn từ đầu đến mục tiêu; trong trường hợp đó Noneđược trả lại. Nếu không, nó trả về một Vecđường dẫn để đi từ đầu đến mục tiêu, bao gồm cả hai điểm cuối.

Để chạy ví dụ, hãy sử dụng cargo run --bin bfs. Đây là hình ảnh kết quả hiển thị đường dẫn từ nút bắt đầu (màu xanh lam) đến nút mục tiêu (màu xanh lá cây):

Tính toán chi phí trong việc tìm đường bằng Rust với thuật toán Dijkstra

Thuật toán Dijkstra là một thuật toán khác để tìm đường đi ngắn nhất từ ​​nút bắt đầu đến nút mục tiêu. Không giống như tìm kiếm theo chiều rộng, nó sử dụng chi phí để di chuyển đến một nút trong các tính toán của nó.

Đảm bảo xem toàn bộ nguồn cho ví dụ này bằng cách sử dụng thuật toán Dijkstra .

Đây là lời gọi để chạy thuật toán Dijkstra:

    let result = dijkstra(
        &start,
        |p| board.get_successors(p).iter().map(|s| (s.pos, s.cost)).collect::<Vec<_>>(),
        |p| *p==goal);

Theo tài liệu chodijkstra() , các đối số rất giống với bfs(). Sự khác biệt duy nhất là đối số thứ hai bây giờ là một Vectrong các bộ giá trị, mỗi bộ giá trị trong số đó chứa những điều sau đây:

• Một nút có thể được chuyển trực tiếp đến
• Chi phí để di chuyển đến nút đó

Một lần nữa, tương tự như bfs(), dijkstra()trả về Option<(Vec<N>, C)>; thành viên thứ hai của bộ tuple là tổng chi phí để đi từ nút bắt đầu đến nút mục tiêu.

Để chạy ví dụ, hãy sử dụng cargo run --bin dijkstravà đây là hình ảnh kết quả hiển thị đường dẫn từ nút bắt đầu (nút có số màu xanh lam) đến nút mục tiêu (nút có số màu xanh lá cây):

Lưu ý rằng đường đi vòng vèo hơn một chút so với đường dẫn trực tiếp vì chi phí của các nút.

Tìm đường gỉ bằng thuật toán tìm kiếm A *

Cả hai tìm kiếm trước đây mà chúng tôi đã xem xét đều bắt đầu bằng cách thử mọi nút được kết nối. Tuy nhiên, vấn đề thường có nhiều cấu trúc hơn mà các thuật toán này không tận dụng được.

Ví dụ: nếu nút mục tiêu của bạn nằm ngay phía tây của nút bắt đầu, thì việc di chuyển đầu tiên là theo hướng về phía tây có lẽ rất hợp lý!

Thuật toán tìm kiếm A * (phát âm là “A-star”) tận dụng lợi thế của cấu trúc bổ sung này. Nó yêu cầu bạn chuyển vào một hàm heuristic ước tính khoảng cách từ một nút đến mục tiêu và ước tính này luôn nhỏ hơn hoặc bằng khoảng cách thực tế.

Sử dụng heuristic này, thuật toán tìm kiếm A * có thể thử các đường dẫn có nhiều khả năng có chi phí thấp hơn trước. Nó cũng có thể tìm ra khi nào nó có thể dừng lại vì không thể có con đường nào ngắn hơn.

Như một cảnh báo: nếu heuristic không tuân theo thuộc tính này, thuật toán có thể không trả về đường đi ngắn nhất! Nếu lo lắng về điều này, bạn có thể chạy một số trường hợp thử nghiệm với thuật toán Dijkstra và xác nhận rằng thuật toán A * và Dijkstra cho cùng một kết quả để đảm bảo rằng heuristic là hợp lệ.

Thông thường, nếu bạn đang thực hiện tìm kiếm đường dẫn trong không gian hai chiều, phương pháp heuristic bỏ qua chi phí và chỉ tính toán khoảng cách giữa hai nút hoạt động tốt.

Ví dụ của chúng tôi Board, chúng tôi không cho phép di chuyển theo đường chéo, vì vậy khoảng cách giữa hai ô là khoảng cách Manhattan . Vì chi phí tối thiểu để đến được ô bất kỳ là bao nhiêu 1, chúng ta có thể sử dụng điều này làm phương pháp phỏng đoán của mình.

Đây là nguồn đầy đủ cho ví dụ này bằng cách sử dụng thuật toán tìm kiếm A * và đây là lời gọi để chạy nó:

    let result = astar(
        &start,
        |p| board.get_successors(p).iter().map(|s| (s.pos, s.cost)).collect::<Vec<_>>(),
        |p| ((p.0 - goal.0).abs() + (p.1 - goal.1).abs()) as u32,
        |p| *p==goal);

Theo tài liệu choastar() , các đối số và giá trị trả về giống với hàm for dijkstra()ngoại trừ hàm heuristic, là tham số thứ ba.

Như đã đề cập ở trên, chúng tôi đang sử dụng khoảng cách Manhattan giữa các ô cho heuristic, là sự khác biệt giữa các giá trị x cộng với sự khác biệt giữa các giá trị y.

Để chạy ví dụ, hãy sử dụng cargo run --bin astar. Đây là hình ảnh kết quả:

Sự kết luận

Khi nói đến tìm kiếm đường dẫn trong Rust, tìm kiếm A * thường được sử dụng trong các ứng dụng người máy và trò chơi điện tử. Tuy nhiên, một điểm yếu của tìm kiếm A * là nó có thể tốn rất nhiều bộ nhớ để chạy.

Có các biến thể như tìm kiếm A * đào sâu lặp đi lặp lại và tìm kiếm rìa cải thiện việc sử dụng bộ nhớ của nó và thùng tìm đường có hỗ trợ cho cả hai điều này với các phương thức idastar()và fringe(). Các phương thức này có các tham số giống như astar()phương thức ở trên, vì vậy chúng rất dễ dùng thử.

Nếu bạn đang tìm cách tìm đường trong Rust, hãy sao chép repo và thử !

Nguồn: https://blog.logrocket.com/pathfinding-rust-tutorial-examples/

#rust 

What is GEEK

Buddha Community

Một Số Tùy Chọn để Tìm Đường Trong Rust

Tìm đường là một vấn đề quan trọng trong nhiều ứng dụng. Trong bài viết này, chúng ta sẽ xem xét một số tùy chọn để tìm đường bằng ngôn ngữ Rust.

Tìm kiếm con đường là gì?

Nói một cách đơn giản, tìm đường là tìm đường ngắn nhất giữa hai điểm. Trong trường hợp đơn giản nhất, câu trả lời là “một đường thẳng”, nhưng mọi thứ có thể trở nên phức tạp hơn nhiều!

Một số ví dụ về các yếu tố phức tạp là:

• Những chướng ngại vật không thể vượt qua
• Địa hình khó di chuyển hơn

Ví dụ: để xử lý các địa hình khó di chuyển hơn, bạn có thể cung cấp cho hai điểm chi phí để di chuyển qua. Sau đó, bạn có thể thay đổi mục tiêu để tìm tuyến đường giữa hai điểm đó với chi phí thấp nhất.

Cách sử dụng của tìm đường

Pathfinding được sử dụng trong nhiều ứng dụng. Một số trong những trò chơi phổ biến nhất là rô bốt và trò chơi điện tử, chẳng hạn như trò chơi mô phỏng .

Trong lĩnh vực chế tạo rô bốt, nhiệm vụ chung của rô bốt là điều hướng môi trường và đi từ điểm A đến điểm B càng nhanh càng tốt.

Trong trò chơi điện tử, một nhân vật do máy tính điều khiển có thể cần di chuyển các vị trí trong môi trường. Ngoài ra, nếu trò chơi cho phép người chơi thiết lập các điểm tham chiếu, họ cũng có thể muốn chỉ ra cách nhanh nhất để đến điểm tham chiếu tiếp theo.

Các ví dụ về tìm đường trong Rust

Bây giờ chúng ta đã thiết lập tính hữu ích của tìm đường, hãy cùng xem một vài ví dụ về tìm đường trong Rust, một ngôn ngữ lập trình ngày càng phổ biến .

Đối với những ví dụ này, chúng tôi sẽ sử dụng thùng có tên aptly, là pathfindingthùng tìm đường phổ biến nhất hiện có trên cơ quan đăng ký thùng của cộng đồng Rust .

 

Lưu ý rằng hầu hết các thuật toán tìm đường hoạt động theo các nút thay vì không gian liên tục. Bài viết dành cho nhà phát triển trò chơi này thảo luận về một số cách để làm cho kết quả của các thuật toán này trông tự nhiên hơn.

Khuôn khổ tìm kiếm đường dẫn Rust mẫu

Bạn có thể xem toàn bộ mã mà chúng tôi sẽ sử dụng trong repo GitHub này .

Cấu Boardtrúc xác định một bảng hình chữ nhật trong đó mỗi ô có thể là một chướng ngại vật hoặc có chi phí liên quan đến việc di chuyển đến nó.

Board::new()cho phép tạo bảng và chỉ định các ô này bằng a Vec<string>. Trong chuỗi này, một ký tự có giá trị từ một đến chín biểu thị một ô có thể được chuyển đến với chi phí đã xác định. Trong khi đó, một ký tự "X" chỉ ra một chướng ngại vật.

Lưu ý rằng các thuật toán này hỗ trợ có liên kết một chiều giữa các ô. Để đơn giản, chúng tôi sẽ không cho phép chức năng đó trong Boardcấu trúc.

Board::get_successors()nhận vào một vị trí ô và trả về một Vectrong các ô có thể được di chuyển trực tiếp đến cùng với chi phí của chúng. Như chúng ta sẽ thấy, đây là một phương pháp chính được sử dụng trong tất cả các thuật toán mà chúng ta sẽ xem xét trong thùng tìm đường.

Ngoài ra còn có Board::draw_to_image(), đây là một cách thuận tiện để viết một hình ảnh với các Boardô - và tùy chọn, cũng là một đường dẫn. Phương pháp này sử dụng imageprocthùng để vẽ.

Sử dụng tìm kiếm theo chiều rộng để tìm kiếm đường dẫn trong Rust

Tìm kiếm theo chiều rộng là một thuật toán khá đơn giản để tìm đường đi ngắn nhất từ ​​nút bắt đầu đến nút mục tiêu. Bắt đầu từ nút bắt đầu, nó xử lý từng nút được kết nối tại một thời điểm.

Nếu nút đó là nút mục tiêu, thì chúng ta đã hoàn tất! Nếu không, chúng tôi đặt mỗi kết nối của nó trong hàng đợi các nút để xem xét và tiếp tục.

Thuật toán tìm kiếm theo chiều rộng không xem xét chi phí của các nút, nhưng nó là một ví dụ khá đơn giản để bắt đầu. Bạn có thể xem toàn bộ nguồn cho ví dụ này bằng cách sử dụng tìm kiếm theo chiều rộng để làm theo.

Đoạn mã dưới đây cho thấy lời kêu gọi thực sự thực hiện tìm kiếm theo chiều rộng-ưu tiên:

    let result = bfs(
        &start,
        |p| board.get_successors(p).iter().map(|successor| successor.pos).collect::<Vec<_>>(), 
        |p| *p==goal);

Theo tài liệu chobfs() , các đối số là:

• Nút để bắt đầu
• Một hàm nhận một nút và trả về một Vectrong số các nút có thể được chuyển trực tiếp đến
• Một hàm nhận một nút và trả về liệu nó có phải là nút mục tiêu hay không

Lưu ý rằng vì tìm kiếm theo chiều rộng không hỗ trợ chi phí cho các nút, chúng tôi phải lập bản đồ kết quả của Board::get_successors()để loại bỏ chi phí.

Ngoài ra, như tài liệu lưu ý, việc tham gia vào một nút và trả lại xem đó có phải là nút mục tiêu hay không sẽ linh hoạt hơn so với việc chỉ xem nút mục tiêu là gì. Điều này là do nó cho phép nhiều nút mục tiêu hoặc một số loại tính toán động để biết liệu một nút có phải là mục tiêu hay không.

Trong trường hợp này, chúng tôi chỉ muốn một nút mục tiêu và điều đó cũng dễ thực hiện!

bfs()trả về Option<Vec<N>>đâu Nlà loại nút bạn đã truyền vào. Đó là Option<>vì có thể không có đường dẫn từ đầu đến mục tiêu; trong trường hợp đó Noneđược trả lại. Nếu không, nó trả về một Vecđường dẫn để đi từ đầu đến mục tiêu, bao gồm cả hai điểm cuối.

Để chạy ví dụ, hãy sử dụng cargo run --bin bfs. Đây là hình ảnh kết quả hiển thị đường dẫn từ nút bắt đầu (màu xanh lam) đến nút mục tiêu (màu xanh lá cây):

Tính toán chi phí trong việc tìm đường bằng Rust với thuật toán Dijkstra

Thuật toán Dijkstra là một thuật toán khác để tìm đường đi ngắn nhất từ ​​nút bắt đầu đến nút mục tiêu. Không giống như tìm kiếm theo chiều rộng, nó sử dụng chi phí để di chuyển đến một nút trong các tính toán của nó.

Đảm bảo xem toàn bộ nguồn cho ví dụ này bằng cách sử dụng thuật toán Dijkstra .

Đây là lời gọi để chạy thuật toán Dijkstra:

    let result = dijkstra(
        &start,
        |p| board.get_successors(p).iter().map(|s| (s.pos, s.cost)).collect::<Vec<_>>(),
        |p| *p==goal);

Theo tài liệu chodijkstra() , các đối số rất giống với bfs(). Sự khác biệt duy nhất là đối số thứ hai bây giờ là một Vectrong các bộ giá trị, mỗi bộ giá trị trong số đó chứa những điều sau đây:

• Một nút có thể được chuyển trực tiếp đến
• Chi phí để di chuyển đến nút đó

Một lần nữa, tương tự như bfs(), dijkstra()trả về Option<(Vec<N>, C)>; thành viên thứ hai của bộ tuple là tổng chi phí để đi từ nút bắt đầu đến nút mục tiêu.

Để chạy ví dụ, hãy sử dụng cargo run --bin dijkstravà đây là hình ảnh kết quả hiển thị đường dẫn từ nút bắt đầu (nút có số màu xanh lam) đến nút mục tiêu (nút có số màu xanh lá cây):

Lưu ý rằng đường đi vòng vèo hơn một chút so với đường dẫn trực tiếp vì chi phí của các nút.

Tìm đường gỉ bằng thuật toán tìm kiếm A *

Cả hai tìm kiếm trước đây mà chúng tôi đã xem xét đều bắt đầu bằng cách thử mọi nút được kết nối. Tuy nhiên, vấn đề thường có nhiều cấu trúc hơn mà các thuật toán này không tận dụng được.

Ví dụ: nếu nút mục tiêu của bạn nằm ngay phía tây của nút bắt đầu, thì việc di chuyển đầu tiên là theo hướng về phía tây có lẽ rất hợp lý!

Thuật toán tìm kiếm A * (phát âm là “A-star”) tận dụng lợi thế của cấu trúc bổ sung này. Nó yêu cầu bạn chuyển vào một hàm heuristic ước tính khoảng cách từ một nút đến mục tiêu và ước tính này luôn nhỏ hơn hoặc bằng khoảng cách thực tế.

Sử dụng heuristic này, thuật toán tìm kiếm A * có thể thử các đường dẫn có nhiều khả năng có chi phí thấp hơn trước. Nó cũng có thể tìm ra khi nào nó có thể dừng lại vì không thể có con đường nào ngắn hơn.

Như một cảnh báo: nếu heuristic không tuân theo thuộc tính này, thuật toán có thể không trả về đường đi ngắn nhất! Nếu lo lắng về điều này, bạn có thể chạy một số trường hợp thử nghiệm với thuật toán Dijkstra và xác nhận rằng thuật toán A * và Dijkstra cho cùng một kết quả để đảm bảo rằng heuristic là hợp lệ.

Thông thường, nếu bạn đang thực hiện tìm kiếm đường dẫn trong không gian hai chiều, phương pháp heuristic bỏ qua chi phí và chỉ tính toán khoảng cách giữa hai nút hoạt động tốt.

Ví dụ của chúng tôi Board, chúng tôi không cho phép di chuyển theo đường chéo, vì vậy khoảng cách giữa hai ô là khoảng cách Manhattan . Vì chi phí tối thiểu để đến được ô bất kỳ là bao nhiêu 1, chúng ta có thể sử dụng điều này làm phương pháp phỏng đoán của mình.

Đây là nguồn đầy đủ cho ví dụ này bằng cách sử dụng thuật toán tìm kiếm A * và đây là lời gọi để chạy nó:

    let result = astar(
        &start,
        |p| board.get_successors(p).iter().map(|s| (s.pos, s.cost)).collect::<Vec<_>>(),
        |p| ((p.0 - goal.0).abs() + (p.1 - goal.1).abs()) as u32,
        |p| *p==goal);

Theo tài liệu choastar() , các đối số và giá trị trả về giống với hàm for dijkstra()ngoại trừ hàm heuristic, là tham số thứ ba.

Như đã đề cập ở trên, chúng tôi đang sử dụng khoảng cách Manhattan giữa các ô cho heuristic, là sự khác biệt giữa các giá trị x cộng với sự khác biệt giữa các giá trị y.

Để chạy ví dụ, hãy sử dụng cargo run --bin astar. Đây là hình ảnh kết quả:

Sự kết luận

Khi nói đến tìm kiếm đường dẫn trong Rust, tìm kiếm A * thường được sử dụng trong các ứng dụng người máy và trò chơi điện tử. Tuy nhiên, một điểm yếu của tìm kiếm A * là nó có thể tốn rất nhiều bộ nhớ để chạy.

Có các biến thể như tìm kiếm A * đào sâu lặp đi lặp lại và tìm kiếm rìa cải thiện việc sử dụng bộ nhớ của nó và thùng tìm đường có hỗ trợ cho cả hai điều này với các phương thức idastar()và fringe(). Các phương thức này có các tham số giống như astar()phương thức ở trên, vì vậy chúng rất dễ dùng thử.

Nếu bạn đang tìm cách tìm đường trong Rust, hãy sao chép repo và thử !

Nguồn: https://blog.logrocket.com/pathfinding-rust-tutorial-examples/

#rust 

Serde Rust: Serialization Framework for Rust

Serde

*Serde is a framework for serializing and deserializing Rust data structures efficiently and generically.*

You may be looking for:

• An overview of Serde
• Data formats supported by Serde
• Setting up #[derive(Serialize, Deserialize)]
• Examples
• API documentation
• Release notes

Serde in action

Click to show Cargo.toml. Run this code in the playground.

[dependencies]

# The core APIs, including the Serialize and Deserialize traits. Always
# required when using Serde. The "derive" feature is only required when
# using #[derive(Serialize, Deserialize)] to make Serde work with structs
# and enums defined in your crate.
serde = { version = "1.0", features = ["derive"] }

# Each data format lives in its own crate; the sample code below uses JSON
# but you may be using a different one.
serde_json = "1.0"

 

use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
struct Point {
    x: i32,
    y: i32,
}

fn main() {
    let point = Point { x: 1, y: 2 };

    // Convert the Point to a JSON string.
    let serialized = serde_json::to_string(&point).unwrap();

    // Prints serialized = {"x":1,"y":2}
    println!("serialized = {}", serialized);

    // Convert the JSON string back to a Point.
    let deserialized: Point = serde_json::from_str(&serialized).unwrap();

    // Prints deserialized = Point { x: 1, y: 2 }
    println!("deserialized = {:?}", deserialized);
}

Getting help

Serde is one of the most widely used Rust libraries so any place that Rustaceans congregate will be able to help you out. For chat, consider trying the #rust-questions or #rust-beginners channels of the unofficial community Discord (invite: https://discord.gg/rust-lang-community), the #rust-usage or #beginners channels of the official Rust Project Discord (invite: https://discord.gg/rust-lang), or the #general stream in Zulip. For asynchronous, consider the [rust] tag on StackOverflow, the /r/rust subreddit which has a pinned weekly easy questions post, or the Rust Discourse forum. It's acceptable to file a support issue in this repo but they tend not to get as many eyes as any of the above and may get closed without a response after some time.

Download Details:
Author: serde-rs
Source Code: https://github.com/serde-rs/serde
License: View license

#rust  #rustlang 

Serde JSON: JSON Support for Serde Framework

Serde JSON

Serde is a framework for serializing and deserializing Rust data structures efficiently and generically.

[dependencies]
serde_json = "1.0"

You may be looking for:

• JSON API documentation
• Serde API documentation
• Detailed documentation about Serde
• Setting up #[derive(Serialize, Deserialize)]
• Release notes

JSON is a ubiquitous open-standard format that uses human-readable text to transmit data objects consisting of key-value pairs.

{
    "name": "John Doe",
    "age": 43,
    "address": {
        "street": "10 Downing Street",
        "city": "London"
    },
    "phones": [
        "+44 1234567",
        "+44 2345678"
    ]
}

There are three common ways that you might find yourself needing to work with JSON data in Rust.

• As text data. An unprocessed string of JSON data that you receive on an HTTP endpoint, read from a file, or prepare to send to a remote server.
• As an untyped or loosely typed representation. Maybe you want to check that some JSON data is valid before passing it on, but without knowing the structure of what it contains. Or you want to do very basic manipulations like insert a key in a particular spot.
• As a strongly typed Rust data structure. When you expect all or most of your data to conform to a particular structure and want to get real work done without JSON's loosey-goosey nature tripping you up.

Serde JSON provides efficient, flexible, safe ways of converting data between each of these representations.

Operating on untyped JSON values

Any valid JSON data can be manipulated in the following recursive enum representation. This data structure is serde_json::Value.

enum Value {
    Null,
    Bool(bool),
    Number(Number),
    String(String),
    Array(Vec<Value>),
    Object(Map<String, Value>),
}

A string of JSON data can be parsed into a serde_json::Value by the serde_json::from_str function. There is also from_slice for parsing from a byte slice &[u8] and from_reader for parsing from any io::Read like a File or a TCP stream.

use serde_json::{Result, Value};

fn untyped_example() -> Result<()> {
    // Some JSON input data as a &str. Maybe this comes from the user.
    let data = r#"
        {
            "name": "John Doe",
            "age": 43,
            "phones": [
                "+44 1234567",
                "+44 2345678"
            ]
        }"#;

    // Parse the string of data into serde_json::Value.
    let v: Value = serde_json::from_str(data)?;

    // Access parts of the data by indexing with square brackets.
    println!("Please call {} at the number {}", v["name"], v["phones"][0]);

    Ok(())
}

The result of square bracket indexing like v["name"] is a borrow of the data at that index, so the type is &Value. A JSON map can be indexed with string keys, while a JSON array can be indexed with integer keys. If the type of the data is not right for the type with which it is being indexed, or if a map does not contain the key being indexed, or if the index into a vector is out of bounds, the returned element is Value::Null.

When a Value is printed, it is printed as a JSON string. So in the code above, the output looks like Please call "John Doe" at the number "+44 1234567". The quotation marks appear because v["name"] is a &Value containing a JSON string and its JSON representation is "John Doe". Printing as a plain string without quotation marks involves converting from a JSON string to a Rust string with as_str() or avoiding the use of Value as described in the following section.

The Value representation is sufficient for very basic tasks but can be tedious to work with for anything more significant. Error handling is verbose to implement correctly, for example imagine trying to detect the presence of unrecognized fields in the input data. The compiler is powerless to help you when you make a mistake, for example imagine typoing v["name"] as v["nmae"] in one of the dozens of places it is used in your code.

Parsing JSON as strongly typed data structures

Serde provides a powerful way of mapping JSON data into Rust data structures largely automatically.

use serde::{Deserialize, Serialize};
use serde_json::Result;

#[derive(Serialize, Deserialize)]
struct Person {
    name: String,
    age: u8,
    phones: Vec<String>,
}

fn typed_example() -> Result<()> {
    // Some JSON input data as a &str. Maybe this comes from the user.
    let data = r#"
        {
            "name": "John Doe",
            "age": 43,
            "phones": [
                "+44 1234567",
                "+44 2345678"
            ]
        }"#;

    // Parse the string of data into a Person object. This is exactly the
    // same function as the one that produced serde_json::Value above, but
    // now we are asking it for a Person as output.
    let p: Person = serde_json::from_str(data)?;

    // Do things just like with any other Rust data structure.
    println!("Please call {} at the number {}", p.name, p.phones[0]);

    Ok(())
}

This is the same serde_json::from_str function as before, but this time we assign the return value to a variable of type Person so Serde will automatically interpret the input data as a Person and produce informative error messages if the layout does not conform to what a Person is expected to look like.

Any type that implements Serde's Deserialize trait can be deserialized this way. This includes built-in Rust standard library types like Vec<T> and HashMap<K, V>, as well as any structs or enums annotated with #[derive(Deserialize)].

Once we have p of type Person, our IDE and the Rust compiler can help us use it correctly like they do for any other Rust code. The IDE can autocomplete field names to prevent typos, which was impossible in the serde_json::Value representation. And the Rust compiler can check that when we write p.phones[0], then p.phones is guaranteed to be a Vec<String> so indexing into it makes sense and produces a String.

The necessary setup for using Serde's derive macros is explained on the Using derive page of the Serde site.

Constructing JSON values

Serde JSON provides a json! macro to build serde_json::Value objects with very natural JSON syntax.

use serde_json::json;

fn main() {
    // The type of `john` is `serde_json::Value`
    let john = json!({
        "name": "John Doe",
        "age": 43,
        "phones": [
            "+44 1234567",
            "+44 2345678"
        ]
    });

    println!("first phone number: {}", john["phones"][0]);

    // Convert to a string of JSON and print it out
    println!("{}", john.to_string());
}

The Value::to_string() function converts a serde_json::Value into a String of JSON text.

One neat thing about the json! macro is that variables and expressions can be interpolated directly into the JSON value as you are building it. Serde will check at compile time that the value you are interpolating is able to be represented as JSON.

let full_name = "John Doe";
let age_last_year = 42;

// The type of `john` is `serde_json::Value`
let john = json!({
    "name": full_name,
    "age": age_last_year + 1,
    "phones": [
        format!("+44 {}", random_phone())
    ]
});

This is amazingly convenient, but we have the problem we had before with Value: the IDE and Rust compiler cannot help us if we get it wrong. Serde JSON provides a better way of serializing strongly-typed data structures into JSON text.

Creating JSON by serializing data structures

A data structure can be converted to a JSON string by serde_json::to_string. There is also serde_json::to_vec which serializes to a Vec<u8> and serde_json::to_writer which serializes to any io::Write such as a File or a TCP stream.

use serde::{Deserialize, Serialize};
use serde_json::Result;

#[derive(Serialize, Deserialize)]
struct Address {
    street: String,
    city: String,
}

fn print_an_address() -> Result<()> {
    // Some data structure.
    let address = Address {
        street: "10 Downing Street".to_owned(),
        city: "London".to_owned(),
    };

    // Serialize it to a JSON string.
    let j = serde_json::to_string(&address)?;

    // Print, write to a file, or send to an HTTP server.
    println!("{}", j);

    Ok(())
}

Any type that implements Serde's Serialize trait can be serialized this way. This includes built-in Rust standard library types like Vec<T> and HashMap<K, V>, as well as any structs or enums annotated with #[derive(Serialize)].

Performance

It is fast. You should expect in the ballpark of 500 to 1000 megabytes per second deserialization and 600 to 900 megabytes per second serialization, depending on the characteristics of your data. This is competitive with the fastest C and C++ JSON libraries or even 30% faster for many use cases. Benchmarks live in the serde-rs/json-benchmark repo.

Getting help

Serde is one of the most widely used Rust libraries, so any place that Rustaceans congregate will be able to help you out. For chat, consider trying the #rust-questions or #rust-beginners channels of the unofficial community Discord (invite: https://discord.gg/rust-lang-community), the #rust-usage or #beginners channels of the official Rust Project Discord (invite: https://discord.gg/rust-lang), or the #general stream in Zulip. For asynchronous, consider the [rust] tag on StackOverflow, the /r/rust subreddit which has a pinned weekly easy questions post, or the Rust Discourse forum. It's acceptable to file a support issue in this repo, but they tend not to get as many eyes as any of the above and may get closed without a response after some time.

No-std support

As long as there is a memory allocator, it is possible to use serde_json without the rest of the Rust standard library. This is supported on Rust 1.36+. Disable the default "std" feature and enable the "alloc" feature:

[dependencies]
serde_json = { version = "1.0", default-features = false, features = ["alloc"] }

For JSON support in Serde without a memory allocator, please see the serde-json-core crate.

Link: https://crates.io/crates/serde_json

#rust  #rustlang  #encode   #json 

Rust Lang Course For Beginner In 2021: Guessing Game

 What we learn in this chapter:
- Rust number types and their default
- First exposure to #Rust modules and the std::io module to read input from the terminal
- Rust Variable Shadowing
- Rust Loop keyword
- Rust if/else
- First exposure to #Rust match keyword

=== Content:
00:00 - Intro & Setup
02:11 - The Plan
03:04 - Variable Secret
04:03 - Number Types
05:45 - Mutability recap
06:22 - Ask the user
07:45 - First intro to module std::io
08:29 - Rust naming conventions
09:22 - Read user input io:stdin().read_line(&mut guess)
12:46 - Break & Understand
14:20 - Parse string to number
17:10 - Variable Shadowing
18:46 - If / Else - You Win, You Loose
19:28 - Loop
20:38 - Match
23:19 - Random with rand
26:35 - Run it all
27:09 - Conclusion and next episode

#rust 

ULTIMATE Rust Lang Tutorial! - Publishing a Rust Crate

The ultimate Rust lang tutorial. Follow along as we go through the Rust lang book chapter by chapter.

📝Get the FREE Rust Cheatsheet: https://letsgetrusty.com/cheatsheet

The Rust book: https://doc.rust-lang.org/stable/book/​​

Chapters:
0:00​ Intro
0:43 Release Profiles
3:00 Documentation Comments
4:32 Commonly Used Sections
5:04 Documentation Comments as Tests
5:50 Commenting Contained Items
6:29 Exporting a Public API
8:44 Setting up Creates.io Account
9:54 Adding Metadata to a New Create
12:14 Publishing to Crates.io
12:49 Removing Version from Crates.io
13:37 Outro

#letsgetrusty​​ #rust​lang​ #tutorial

#rust #rust lang #rust crate